third_party/WebKit/Source/modules/webdatabase/sqlite/SQLiteFileSystemWin.cpp

/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// Expose chromium_sqlite3_* functions from Chromium's patched SQLite.
#define CHROMIUM_SQLITE_INTERNALS

#include "modules/webdatabase/sqlite/SQLiteFileSystem.h"

#include <windows.h>
#include "public/platform/Platform.h"
#include "third_party/sqlite/sqlite3.h"

namespace blink {

// Chromium's Windows implementation of SQLite VFS
namespace {

// Opens a file.
//
// vfs - pointer to the sqlite3_vfs object.
// fileName - the name of the file.
// id - the structure that will manipulate the newly opened file.
// desiredFlags - the desired open mode flags.
// usedFlags - the actual open mode flags that were used.
int chromiumOpen(sqlite3_vfs*,
                 const char* fileName,
                 sqlite3_file* id,
                 int desiredFlags,
                 int* usedFlags) {
  HANDLE h =
      Platform::current()->databaseOpenFile(String(fileName), desiredFlags);
  if (h == INVALID_HANDLE_VALUE) {
    if (desiredFlags & SQLITE_OPEN_READWRITE) {
      int newFlags =
          (desiredFlags | SQLITE_OPEN_READONLY) & ~SQLITE_OPEN_READWRITE;
      return chromiumOpen(0, fileName, id, newFlags, usedFlags);
    } else
      return SQLITE_CANTOPEN;
  }
  if (usedFlags) {
    if (desiredFlags & SQLITE_OPEN_READWRITE)
      *usedFlags = SQLITE_OPEN_READWRITE;
    else
      *usedFlags = SQLITE_OPEN_READONLY;
  }

  chromium_sqlite3_initialize_win_sqlite3_file(id, h);
  return SQLITE_OK;
}

// Deletes the given file.
//
// vfs - pointer to the sqlite3_vfs object.
// fileName - the name of the file.
// syncDir - determines if the directory to which this file belongs
//           should be synched after the file is deleted.
int chromiumDelete(sqlite3_vfs*, const char* fileName, int) {
  return Platform::current()->databaseDeleteFile(String(fileName), false);
}

// Check the existance and status of the given file.
//
// vfs - pointer to the sqlite3_vfs object.
// fileName - the name of the file.
// flag - the type of test to make on this file.
// res - the result.
int chromiumAccess(sqlite3_vfs*, const char* fileName, int flag, int* res) {
  DWORD attr = Platform::current()->databaseGetFileAttributes(String(fileName));
  switch (flag) {
    case SQLITE_ACCESS_READ:
    case SQLITE_ACCESS_EXISTS:
      *res = (attr != INVALID_FILE_ATTRIBUTES);
      break;
    case SQLITE_ACCESS_READWRITE:
      *res = ((attr & FILE_ATTRIBUTE_READONLY) == 0);
      break;
    default:
      return SQLITE_ERROR;
  }

  return SQLITE_OK;
}

// Turns a relative pathname into a full pathname.
//
// vfs - pointer to the sqlite3_vfs object.
// relativePath - the relative path.
// bufSize - the size of the output buffer in bytes.
// absolutePath - the output buffer where the absolute path will be stored.
int chromiumFullPathname(sqlite3_vfs* vfs,
                         const char* relativePath,
                         int bufSize,
                         char* absolutePath) {
  // The renderer process doesn't need to know the absolute path of the file
  sqlite3_snprintf(bufSize, absolutePath, "%s", relativePath);
  return SQLITE_OK;
}

// Do not allow loading libraries in the renderer.
void* chromiumDlOpen(sqlite3_vfs*, const char*) {
  return 0;
}

void chromiumDlError(sqlite3_vfs*, int bufSize, char* errorBuffer) {
  sqlite3_snprintf(bufSize, errorBuffer, "Dynamic loading not supported");
}

void (*chromiumDlSym(sqlite3_vfs*, void*, const char*))(void) {
  return 0;
}

void chromiumDlClose(sqlite3_vfs*, void*) {}

int chromiumRandomness(sqlite3_vfs* vfs, int bufSize, char* buffer) {
  sqlite3_vfs* wrappedVfs = static_cast<sqlite3_vfs*>(vfs->pAppData);
  return wrappedVfs->xRandomness(wrappedVfs, bufSize, buffer);
}

int chromiumSleep(sqlite3_vfs* vfs, int microseconds) {
  sqlite3_vfs* wrappedVfs = static_cast<sqlite3_vfs*>(vfs->pAppData);
  return wrappedVfs->xSleep(wrappedVfs, microseconds);
}

int chromiumCurrentTime(sqlite3_vfs* vfs, double* prNow) {
  sqlite3_vfs* wrappedVfs = static_cast<sqlite3_vfs*>(vfs->pAppData);
  return wrappedVfs->xCurrentTime(wrappedVfs, prNow);
}

int chromiumGetLastError(sqlite3_vfs* vfs, int e, char* s) {
  // xGetLastError() has never been used by SQLite.  The implementation in
  // os_win.c indicates this is a reasonable implementation.
  *s = '\0';
  return 0;
}

}  // namespace

void SQLiteFileSystem::registerSQLiteVFS() {
  sqlite3_vfs* wrappedVfs = sqlite3_vfs_find("win32");

  // These are implemented by delegating to |wrappedVfs|.
  // TODO(shess): Implement local versions.
  ASSERT(wrappedVfs->xRandomness);
  ASSERT(wrappedVfs->xSleep);
  ASSERT(wrappedVfs->xCurrentTime);

  static sqlite3_vfs chromium_vfs = {1,
                                     wrappedVfs->szOsFile,
                                     wrappedVfs->mxPathname,
                                     0,
                                     "chromium_vfs",
                                     wrappedVfs,
                                     chromiumOpen,
                                     chromiumDelete,
                                     chromiumAccess,
                                     chromiumFullPathname,
                                     chromiumDlOpen,
                                     chromiumDlError,
                                     chromiumDlSym,
                                     chromiumDlClose,
                                     chromiumRandomness,
                                     chromiumSleep,
                                     chromiumCurrentTime,
                                     chromiumGetLastError};
  sqlite3_vfs_register(&chromium_vfs, 0);
}

}  // namespace blink