Oops, committed debugging message.
[project/views.git] / views.install
index 5c9d238..422ee46 100644 (file)
 <?php
-  // $Id$
-
-  function views_install() {
-    drupal_set_message('Installing views');
-    switch ($GLOBALS['db_type']) {
-      case 'mysqli':
-      case 'mysql':
-      db_query("CREATE TABLE if not exists {view_view} (
-        vid int(10) unsigned NOT NULL default '0',
-        name varchar(32) NOT NULL UNIQUE,
-        description varchar(255),
-        access varchar(255),
-        -- page fields
-        page int(1),
-        page_title varchar(255),
-        page_header longtext,
-        page_header_format int(4) NOT NULL,
-        page_empty longtext,
-        page_empty_format int(4) NOT NULL,
-        page_footer longtext,
-        page_footer_format int(4) NOT NULL,
-        page_type varchar(20),
-        use_pager int(1),
-        nodes_per_page int(5),
-        url varchar(255),
-        -- menu fields
-        menu int(1),
-        menu_tab int(1),
-        menu_tab_default int(1),
-        menu_tab_weight int(4),
-        menu_title varchar(255),
-        -- block fields
-        block int(1),
-        block_title varchar(255),
-        block_use_page_header int(1),
-        block_header longtext,
-        block_header_format int(4) NOT NULL,
-        block_use_page_footer int(1),
-        block_footer longtext,
-        block_footer_format int(4) NOT NULL,
-        block_use_page_empty int(1),
-        block_empty longtext,
-        block_empty_format int(4) NOT NULL,
-        block_type varchar(20),
-        nodes_per_block int(5),
-        block_more int(1),
-        -- breadcrumb
-        breadcrumb_no_home int(1), -- true means start breadcrumb trail from 'Home'.
-        -- other
-        changed int(11),
-        query longtext,
-        countquery longtext,
-        view_args_php longtext,
-        PRIMARY KEY (vid),
-        KEY (name)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-
-      db_query("CREATE TABLE if not exists {view_sort} (
-        vid int(10) unsigned NOT NULL default '0',
-        position int(2),
-        field varchar(255),
-        sortorder varchar(5),
-        options varchar(255),
-        tablename varchar(255),
-        KEY (vid)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-
-      db_query("CREATE TABLE if not exists {view_argument} (
-        vid int(10) unsigned NOT NULL default '0',
-        type varchar(255),
-        argdefault varchar(255),
-        title varchar(255),
-        options varchar(255),
-        position int(2),
-        wildcard varchar(32),
-        wildcard_substitution varchar(32),
-        KEY (vid)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-
-      db_query("CREATE TABLE if not exists {view_tablefield} (
-        vid int(10) unsigned NOT NULL default '0',
-        tablename varchar(255),
-        field varchar(255),
-        label varchar(255),
-        handler varchar(255),
-        sortable int(1),
-        defaultsort varchar(5),
-        options varchar(255),
-        position int(2),
-        KEY (vid)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-
-      db_query("CREATE TABLE if not exists {view_filter} (
-        vid int(10) unsigned NOT NULL default '0',
-        tablename varchar(255),
-        field varchar(255),
-        value longtext,
-        operator varchar(20),
-        options varchar(255),
-        position int(2),
-        KEY (vid)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-
-      db_query("CREATE TABLE if not exists {view_exposed_filter} (
-        vid int(10) unsigned NOT NULL default '0',
-        field varchar(255),
-        label varchar(255),
-        optional int(1),
-        is_default int(1),
-        operator int(1),
-        single int(1),
-        position int(2),
-        KEY (vid)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-
-      $success = TRUE;
-      break;
-    case 'pgsql':
-      db_query("CREATE TABLE {view_view} (
-        vid SERIAL,
-        name varchar(32) NOT NULL UNIQUE,
-        description varchar(255),
-        access varchar(255),
-        -- page fields
-        page smallint,
-        page_title varchar(255),
-        page_header text,
-        page_header_format smallint NOT NULL,
-        page_empty text,
-        page_empty_format smallint NOT NULL,
-        page_footer text,
-        page_footer_format smallint NOT NULL,
-        page_type varchar(20),
-        use_pager smallint,
-        nodes_per_page smallint, 
-        url varchar(255),
-        -- menu fields
-        menu smallint,
-        menu_tab smallint,
-        menu_tab_default smallint,
-        menu_tab_weight smallint,
-        menu_title varchar(255),
-        -- block fields
-        block smallint,
-        block_title varchar(255),
-        block_use_page_header smallint,
-        block_header text,
-        block_header_format smallint NOT NULL,
-        block_use_page_footer smallint,
-        block_footer text,
-        block_footer_format smallint NOT NULL,
-        block_use_page_empty smallint,
-        block_empty text,
-        block_empty_format smallint NOT NULL,
-        block_type varchar(20),
-        nodes_per_block smallint,
-        block_more smallint,
-        -- breadcrumb
-        breadcrumb_no_home smallint, -- true means start breadcrumb trail from 'Home'.
-        -- other
-        changed integer,
-        query text,
-        countquery text,
-        view_args_php text,
-        PRIMARY KEY (vid)
-      )");
-      db_query("CREATE INDEX {view_view}_name_idx ON {view_view} (name)");
-
-      db_query("CREATE TABLE {view_sort} (
-        vid integer NOT NULL default '0',
-        position smallint,
-        field varchar(255),
-        sortorder varchar(5),
-        options varchar(255),
-        tablename varchar(255)
-      )");
-      db_query("CREATE INDEX {view_sort}_vid_idx ON {view_sort} (vid)");
-
-      db_query("CREATE TABLE {view_argument} (
-        vid integer NOT NULL default '0',
-        type varchar(255),
-        argdefault varchar(255),
-        title varchar(255),
-        options varchar(255),
-        position smallint,
-        wildcard varchar(32),
-        wildcard_substitution varchar(32)
-      )");
-      db_query("CREATE INDEX {view_argument}_vid_idx ON {view_argument} (vid)");
-
-      db_query("CREATE TABLE {view_tablefield} (
-        vid integer NOT NULL default '0',
-        tablename varchar(255),
-        field varchar(255),
-        label varchar(255),
-        handler varchar(255),
-        sortable smallint,
-        defaultsort varchar(5),
-        options varchar(255),
-        position smallint
-      )");
-      db_query("CREATE INDEX {view_tablefield}_vid_idx ON {view_tablefield} (vid)");
-
-      db_query("CREATE TABLE {view_filter} (
-        vid integer NOT NULL default '0',
-        tablename varchar(255),
-        field varchar(255),
-        value text,
-        operator varchar(20),
-        options varchar(255),
-        position smallint
-      )");
-      db_query("CREATE INDEX {view_filter}_vid_idx ON {view_filter} (vid)");
-      db_query("CREATE TABLE {view_exposed_filter} (
-        vid integer NOT NULL default '0',
-        field varchar(255),
-        label varchar(255),
-        optional smallint,
-        is_default smallint,
-        operator smallint,
-        single smallint,
-        position smallint
-      )");
-      db_query("CREATE INDEX {view_exposed_filter}_vid_idx ON {view_exposed_filter} (vid)");
-
-      $success = TRUE;
-      break;
-  } // End case
+// $Id$
+/**
+ * @file views.install
+ * Contains install and update functions for Views.
+ */
 
-  if ($success) {
-    drupal_set_message(t('Views module installed tables successfully.'));
-  }
-  else {
-    drupal_set_message(t('The installation of views module was unsuccessful.'), 'error');
+function views_install() {
+  if ($GLOBALS['db_type'] == 'pgsql') {
+    db_query('CREATE OR REPLACE FUNCTION first(anyelement, anyelement) RETURNS anyelement AS \'SELECT COALESCE($1, $2);\' LANGUAGE \'sql\';');
+    db_query("DROP AGGREGATE IF EXISTS first(anyelement)");
+    db_query("CREATE AGGREGATE first(sfunc = first, basetype = anyelement, stype = anyelement);");
   }
+  drupal_install_schema('views');
+  db_query("UPDATE {system} SET weight = 10 WHERE name = 'views'");
 }
 
 function views_uninstall() {
-  db_query("DROP TABLE IF EXISTS {view_view}");
-  db_query("DROP TABLE IF EXISTS {view_sort}");
-  db_query("DROP TABLE IF EXISTS {view_argument}");
-  db_query("DROP TABLE IF EXISTS {view_tablefield}");
-  db_query("DROP TABLE IF EXISTS {view_filter}");
-  db_query("DROP TABLE IF EXISTS {view_exposed_filter}");
+  drupal_uninstall_schema('views');
 }
 
-/*
- * update module for UTF.
+/**
+ * Implementation of hook_schemea
  */
-function views_update_1() {
-  return _system_update_utf8(array('view_view', 'view_tablefield', 'view_filter', 'view_sort', 'view_argument'));
+function views_schema() {
+  // Currently, schema 1 is the only schema we have. As we make updates,
+  // we might either create a new schema 2 or make adjustments here.
+  return views_schema_1();
 }
 
 /**
- * Dummy function cause we're apparently not to skip update #s.
+ * Views 2's initial schema; separated for the purposes of updates.
  */
-function views_update_2() {
-// dummy function
-  return array();
+function views_schema_1() {
+  $schema['views_view'] = array(
+    'description' => 'Stores the general data for a view.',
+    'fields' => array(
+      'vid' => array(
+        'type' => 'serial',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'description' => 'The view ID of the field, defined by the database.',
+        'no export' => TRUE,
+      ),
+      'name' => array(
+        'type' => 'varchar',
+        'length' => '32',
+        'default' => '',
+        'not null' => TRUE,
+        'description' => 'The unique name of the view. This is the primary field views are loaded from, and is used so that views may be internal and not necessarily in the database. May only be alphanumeric characters plus underscores.',
+      ),
+      'description' => array(
+        'type' => 'varchar',
+        'length' => '255',
+        'default' => '',
+        'description' => 'A description of the view for the admin interface.',
+      ),
+      'tag' => array(
+        'type' => 'varchar',
+        'length' => '255',
+        'default' => '',
+        'description' => 'A tag used to group/sort views in the admin interface',
+      ),
+      'view_php' => array(
+        'type' => 'blob',
+        'description' => 'A chunk of PHP code that can be used to provide modifications to the view prior to building.',
+      ),
+      'base_table' => array(
+        'type' => 'varchar',
+        'length' => '64',
+        'default' => '',
+        'not null' => TRUE,
+        'description' => 'What table this view is based on, such as node, user, comment, or term.',
+      ),
+      'is_cacheable' => array(
+        'type' => 'int',
+        'default' => 0,
+        'size' => 'tiny',
+        'description' => 'A boolean to indicate whether or not this view may have its query cached.',
+      ),
+    ),
+    'primary key' => array('vid'),
+    'unique keys' => array('name' => array('name')),
+  );
+
+  $schema['views_display'] = array(
+    'description' => 'Stores information about each display attached to a view.',
+    'fields' => array(
+      'vid' => array(
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'The view this display is attached to.',
+        'no export' => TRUE,
+      ),
+      'id' => array(
+        'type' => 'varchar',
+        'length' => '64',
+        'default' => '',
+        'not null' => TRUE,
+        'description' => 'An identifier for this display; usually generated from the display_plugin, so should be something like page or page_1 or block_2, etc.',
+      ),
+      'display_title' => array(
+        'type' => 'varchar',
+        'length' => '64',
+        'default' => '',
+        'not null' => TRUE,
+        'description' => 'The title of the display, viewable by the administrator.',
+      ),
+      'display_plugin' => array(
+        'type' => 'varchar',
+        'length' => '64',
+        'default' => '',
+        'not null' => TRUE,
+        'description' => 'The type of the display. Usually page, block or embed, but is pluggable so may be other things.',
+      ),
+      'position' => array(
+        'type' => 'int',
+        'default' => 0,
+        'description' => 'The order in which this display is loaded.',
+      ),
+      'display_options' => array(
+        'type' => 'blob',
+        'description' => 'A serialized array of options for this display; it contains options that are generally only pertinent to that display plugin type.',
+        'serialize' => TRUE,
+        'serialized default' => 'a:0:{}',
+      ),
+    ),
+    'indexes' => array('vid' => array('vid', 'position')),
+  );
+
+  $schema['cache_views'] = drupal_get_schema_unprocessed('system', 'cache');
+  
+  $schema['cache_views_data'] = drupal_get_schema_unprocessed('system', 'cache');
+  $schema['cache_views_data']['description'] = 'Cache table for views to store pre-rendered queries, results, and display output.';
+  $schema['cache_views_data']['fields']['serialized']['default'] = 1;
+
+
+  $schema['views_object_cache'] = array(
+    'description' => 'A special cache used to store objects that are being edited; it serves to save state in an ordinarily stateless environment.',
+    'fields' => array(
+      'sid' => array(
+        'type' => 'varchar',
+        'length' => '64',
+        'description' => 'The session ID this cache object belongs to.',
+      ),
+      'name' => array(
+        'type' => 'varchar',
+        'length' => '32',
+        'description' => 'The name of the view this cache is attached to.',
+      ),
+      'obj' => array(
+        'type' => 'varchar',
+        'length' => '32',
+        'description' => 'The name of the object this cache is attached to; this essentially represents the owner so that several sub-systems can use this cache.',
+      ),
+      'updated' => array(
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'The time this cache was created or updated.',
+      ),
+      'data' => array(
+        'type' => 'text',
+        'size' => 'big',
+        'description' => 'Serialized data being stored.',
+        'serialize' => TRUE,
+      ),
+    ),
+    'indexes' => array(
+      'sid_obj_name' => array('sid', 'obj', 'name'),
+      'updated' => array('updated'),
+    ),
+  );
+  return $schema;
 }
-/*
- * update module for exposed filters.
+
+/**
+ * Update a site to Drupal 6! Contains a bit of special code to detect
+ * if you've been running a beta version or something.
  */
-function views_update_3() {
+function views_update_6000() {
   $ret = array();
-//  db_add_column($ret, 'view_view', 'page_empty', 'longtext');
-//  db_add_column($ret, 'view_view', 'page_empty_format', 'int(4)', array('not null' => TRUE));
-//  db_add_column($ret, 'view_view', 'block_use_page_empty', 'int(1)');
-//  db_add_column($ret, 'view_view', 'block_empty', 'longtext');
-//  db_add_column($ret, 'view_view', 'block_empty_format', 'int(4)', array('not null' => TRUE));
-  switch($GLOBALS['db_type']) {
-    case 'mysql':
-    case 'mysqli':
-    $ret[] = update_sql("CREATE TABLE if not exists {view_exposed_filter} (
-        vid int(10) unsigned NOT NULL default '0',
-        field varchar(255),
-        label varchar(255),
-        optional int(1),
-        is_default int(1),
-        operator int(1),
-        single int(1),
-        position int(2),
-        KEY (vid)
-      ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;");
-      break;
-    case 'pgsql':
-      $ret[] = update_sql("CREATE TABLE {view_exposed_filter} (
-        vid numeric(10) unsigned NOT NULL default '0',
-        field varchar(255),
-        label varchar(255),
-        optional numeric(1),
-        is_default numeric(1),
-        operator numeric(1),
-        single numeric(1),
-        position numeric(2),
-      )");
-      $ret[] = update_sql("CREATE INDEX {view_exposed_filter}_vid_idx ON {view_exposed_filter} (vid)");
-      break;
+  if (db_table_exists('views_view')) {
+    return $ret;
   }
-  return $ret;
-}
 
-function views_update_4() {
-  $ret = array();
-  db_add_column($ret, 'view_view', 'page_footer', 'longtext');
-  db_add_column($ret, 'view_view', 'page_footer_format', 'int(4)', array('default' => 0));
-  db_add_column($ret, 'view_view', 'block_use_page_footer', 'int(1)');
-  db_add_column($ret, 'view_view', 'block_footer', 'longtext');
-  db_add_column($ret, 'view_view', 'block_footer_format', 'int(4)', array('default' => 0));
-  db_add_column($ret, 'view_view', 'page_empty', 'longtext');
-  db_add_column($ret, 'view_view', 'page_empty_format', 'int(4)', array('default' => 0));
-  db_add_column($ret, 'view_view', 'block_use_page_empty', 'int(1)');
-  db_add_column($ret, 'view_view', 'block_empty', 'longtext');
-  db_add_column($ret, 'view_view', 'block_empty_format', 'int(4)', array('default' => 0));
+  // This has the beneficial effect of wiping out any Views 1 cache at the
+  // same time; not wiping that cache could easily cause problems with Views 2.
+  if (db_table_exists('cache_views')) {
+    db_drop_table($ret, 'cache_views');
+  }
+
+  // This is mostly the same as drupal_install_schema, but it forces
+  // views_schema_1 rather than the default schema. This will be important
+  // if we have table updates.
+  $schema = views_schema_1();
+  _drupal_initialize_schema('views', $schema);
+
+  foreach ($schema as $name => $table) {
+    db_create_table($ret, $name, $table);
+  }
   return $ret;
 }
 
-function views_update_5() {
+function views_update_6001() {
   $ret = array();
-  db_add_column($ret, 'view_view', 'view_args_php', 'longtext');
+  $result = db_query("SELECT * FROM {blocks} WHERE module = 'views' AND delta LIKE '\$exp%'");
+  while ($block = db_fetch_object($result)) {
+    $new = strtr($block->delta, '$', '-');
+    $ret[] = update_sql("UPDATE {blocks} SET delta = '" . db_escape_string($new) . "' WHERE module = 'views' AND delta = '" . db_escape_string($block->delta) . "'");
+  }
+  $ret[] = update_sql("UPDATE {blocks} SET delta = CONCAT(delta, '-block_1') WHERE module = 'views'");
+
   return $ret;
 }
 
-function views_update_6() {
+// NOTE: Update 6002 removed because it did not always work.
+/**
+ * Add missing unique key.
+ */
+function views_update_6003() {
   $ret = array();
-  db_add_column($ret, 'view_tablefield', 'options', 'varchar(255)');
+
+  db_add_unique_key($ret, 'views_view', 'name', array('name'));
+
   return $ret;
 }
 
-function views_update_7() {
+/**
+ * Enlarge the views_object_cache.data column to prevent truncation and JS
+ * errors.
+ */
+function views_update_6004() {
   $ret = array();
-  $ret[] = update_sql("ALTER TABLE {view_argument} MODIFY type varchar(255)");
+
+  $new_field = array(
+    'type' => 'text',
+    'size' => 'big',
+    'description' => 'Serialized data being stored.',
+    'serialize' => TRUE,
+  );
+
+  // Drop and re-add this field because there is a bug in
+  // db_change_field that causes this to fail when trying to cast the data.
+  db_drop_field($ret, 'views_object_cache', 'data');
+  db_add_field($ret, 'views_object_cache', 'data', $new_field);
+
   return $ret;
 }
 
-function views_update_8() {
+/**
+ * Enlarge the base_table column
+ */
+function views_update_6005() {
   $ret = array();
-  $ret[] = update_sql("ALTER TABLE {view_view} MODIFY nodes_per_page int(5)");
+  
+  $new_field = array(
+    'type' => 'varchar',
+    'length' => '64',
+    'default' => '',
+    'not null' => TRUE,
+    'description' => 'What table this view is based on, such as node, user, comment, or term.',
+  );
+  db_change_field($ret, 'views_view', 'base_table', 'base_table', $new_field);
   return $ret;
 }
 
-function views_update_9() {
+/**
+ * Add the cache_views_data table to support standard caching.
+ */
+function views_update_6006() {
   $ret = array();
-  db_add_column($ret, 'view_argument', 'wildcard', 'varchar(32)');
-  db_add_column($ret, 'view_argument', 'wildcard_substitution', 'varchar(32)');
+  
+  $table = drupal_get_schema_unprocessed('system', 'cache');
+  $table['description'] = 'Cache table for views to store pre-rendered queries, results, and display output.';
+  $table['fields']['serialized']['default'] = 1;
+
+  db_create_table($ret, 'cache_views_data', $table);
+
   return $ret;
 }
 
-function views_update_10() {
+/**
+ * Add aggregate function to PostgreSQL so GROUP BY can be used to force only
+ * one result to be returned for each item.
+ */
+function views_update_6007() {
   $ret = array();
-  $ret[] = update_sql("UPDATE {system} SET weight = 10 WHERE name = 'views'");
+  if ($GLOBALS['db_type'] == 'pgsql') {
+    $ret[] = update_sql('CREATE OR REPLACE FUNCTION first(anyelement, anyelement) RETURNS anyelement AS \'SELECT COALESCE($1, $2);\' LANGUAGE \'sql\';');
+    $ret[] = update_sql("DROP AGGREGATE IF EXISTS first(anyelement)");
+    $ret[] = update_sql("CREATE AGGREGATE first(sfunc = first, basetype = anyelement, stype = anyelement);");
+  }
   return $ret;
 }