Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: ea1407baa6
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 299 lines (291 sloc) 10.1 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
<?php

// $Id$

/**
 * @file
 *
 * Installs the required database schema for storing display and control properties for the viewer.
 */
module_load_include('inc', 'content_model_viewer', 'content_model_viewer.db');

/**
 * Implementation of hook_install.
 */
function content_model_viewer_install() {
  drupal_install_schema('content_model_viewer');
  content_model_viewer_add_foreign_key_constraints();
  content_model_viewer_add_default_settings();
  content_model_viewer_set_default_rules();
}

/**
 * Implementation of hook_uninstall.
 */
function content_model_viewer_uninstall() {
  drupal_uninstall_schema('content_model_viewer');
}

/**
 * Adds foreign key constraints for all settings tables.
 *
 * On Delete of a Settings all tables with foreign key constrains will cascade the deletes.
 */
function content_model_viewer_add_foreign_key_constraints() {
  $table = CONTENT_MODEL_VIEWER_SETTINGS_TABLE;
  $constraint_query = <<<EOT
  ALTER TABLE `{%table%}` ADD CONSTRAINT `{%table%}_model_id`
  FOREIGN KEY (`model_id`)
  REFERENCES `{$table}` (`id`)
  ON DELETE CASCADE
  ON UPDATE NO ACTION
EOT;
  $tables = array(
    CONTENT_MODEL_VIEWER_DATASTREAM_MIMETYPE_RULES_TABLE,
    CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE,
    CONTENT_MODEL_VIEWER_DATASTREAM_RELS_VIEW_DERIVED_RULES_TABLE,
    CONTENT_MODEL_VIEWER_DATASTREAM_DSID_VIEW_DERIVED_RULES_TABLE
  );
  foreach ($tables as $table) {
    $query = str_replace('%table%', $table, $constraint_query);
    db_query($query);
  }
}

/**
 * Add the default settings model, this should not be removed from the database, unless the module
 * is being uninstalled.
 */
function content_model_viewer_add_default_settings() {
  $row = new stdClass();
  db_query("INSERT INTO {%s} (`id`, `pid`, `view`, `download`) VALUES ('%d', 'default', '1', '1')", CONTENT_MODEL_VIEWER_SETTINGS_TABLE, CONTENT_MODEL_VIEWER_DEFAULT_SETTINGS_MODEL_ID);
}

/**
 * Clears the default Settings and restores the default Settings.
 */
function content_model_viewer_set_default_rules() {
  // Hide Fedora Specific Datastreams.
  $table = CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE;
  $model_id = CONTENT_MODEL_VIEWER_DEFAULT_SETTINGS_MODEL_ID;
  $rule = CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT;
  $hidden = array('POLICY', 'DC', 'RELS-EXT', 'RELS-INT', 'ISLANDORACM', 'COLLECTION_POLICY');
  foreach ($hidden as $dsid) {
    db_query("INSERT INTO {%s} (`model_id`, `dsid`, `type`, `view`, `download`) VALUES ('%d', '%s', '%d', '0', '0')", $table, $model_id, $dsid, $rule);
  }
  // Redirect PDF's to SWF's
  $table = CONTENT_MODEL_VIEWER_DATASTREAM_DSID_VIEW_DERIVED_RULES_TABLE;
  $src_dsid = 'PDF';
  $src_type = CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT;
  $dest_dsid = 'SWF';
  $dest_type = CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT;
  db_query("INSERT INTO {%s} (`model_id`, `src_dsid`, `src_type`, `dest_dsid`, `dest_type`) VALUES ('%d', '%s', '%d', '%s', '%d')", $table, $model_id, $src_dsid, $src_type, $dest_dsid, $dest_type);
  // RELS-INT
  $table = CONTENT_MODEL_VIEWER_DATASTREAM_RELS_VIEW_DERIVED_RULES_TABLE;
  $mime = 'application/pdf';
  $xpath = '/*[local-name() = "hasSWF"]/@rdf:resource';
  $matching = '[^\/]*$';
  $type = CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_REGEX;
  db_query("INSERT INTO {%s} (`model_id`, `mime`, `xpath`, `matching`, `type`) VALUES ('%d', '%s', '%d', '%s', '%d')", $table, $model_id, $mime, $xpath, $matching, $type);
}

/**
 * Implementation of hook_schema.
 *
 * @return array
 */
function content_model_viewer_schema() {
  $schema[CONTENT_MODEL_VIEWER_DATASTREAM_RELS_VIEW_DERIVED_RULES_TABLE] = array(
    'description' => t(''),
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'not null' => TRUE,
      ),
      'model_id' => array(
        'type' => 'int',
        'not null' => TRUE
      ),
      'mime' => array(
        'description' => t('A MIME type.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'xpath' => array(
        'description' => t('An XPath type.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'matching' => array(
        'description' => t('A Regex or string to match the value returned from XPath.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => t('The type of value within dsid.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT // Expected to 0 or 1, where 0 is exact and 1 in regex.
      ),
    ),
    'primary key' => array('id'),
    'indexes' => array(
      'model_id' => array('model_id'),
    ),
  );
  $schema[CONTENT_MODEL_VIEWER_DATASTREAM_DSID_VIEW_DERIVED_RULES_TABLE] = array(
    'description' => t(''),
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'not null' => TRUE,
      ),
      'model_id' => array(
        'type' => 'int',
        'not null' => TRUE
      ),
      'src_dsid' => array(
        'description' => t('A MIME type.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'src_type' => array(
        'description' => t('The type of value within dsid.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT // Expected to 0 or 1, where 0 is exact and 1 in regex.
      ),
      'dest_dsid' => array(
        'description' => t('A Regex or string to match the value returned from XPath.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'dest_type' => array(
        'description' => t('The type of value within dsid.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT // Expected to 0 or 1, where 0 is exact and 1 in regex.
      ),
    ),
    'primary key' => array('id'),
    'indexes' => array(
      'model_id' => array('model_id'),
    ),
  );
  $schema[CONTENT_MODEL_VIEWER_DATASTREAM_MIMETYPE_RULES_TABLE] = array(
    'description' => t('This table is used to store rules for displaying/viewing/downloading datastreams for non-admin users.'),
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'not null' => TRUE,
      ),
      'model_id' => array(
        'type' => 'int',
        'not null' => TRUE
      ),
      'mime' => array(
        'description' => t('A MIME type.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'view' => array(
        'description' => t('TRUE if the user is allowed to view datastreams that match this rule FALSE otherwise.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
      'download' => array(
        'description' => t('TRUE if the user is allowed to download datastreams that match this rule FALSE otherwise.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
    ),
    'primary key' => array('id'),
    'indexes' => array(
      'model_id' => array('model_id'),
    ),
  );
  $schema[CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE] = array(
    'description' => t('This table is used to store rules for displaying/viewing/downloading datastreams for non-admin users.'),
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'not null' => TRUE,
      ),
      'model_id' => array(
        'type' => 'int',
        'not null' => TRUE
      ),
      'dsid' => array(
        'description' => t('A regular expression for matching against a Datastream ID.'),
        'type' => 'varchar',
        'length' => 256,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => t('The type of value within dsid.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_EXACT // Expected to 0 or 1, where 0 is exact and 1 in regex.
      ),
      'view' => array(
        'description' => t('TRUE if the user is allowed to view datastreams that match this rule FALSE otherwise.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
      'download' => array(
        'description' => t('TRUE if the user is allowed to download datastreams that match this rule FALSE otherwise.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
    ),
    'primary key' => array('id'),
    'indexes' => array(
      'model_id' => array('model_id'),
    ),
  );
  /* Defines the point of customization */
  $schema[CONTENT_MODEL_VIEWER_SETTINGS_TABLE] = array(
    'description' => t('This table is used to store associations between XML Form API style form definitions, and the Content models that use them.'),
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'not null' => TRUE,
      ),
      'pid' => array(
        'description' => t('The content model pid.'),
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE
      ),
      'view' => array(
        'description' => t('TRUE if the user is allowed to view datastreams that match this rule FALSE otherwise.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
      'download' => array(
        'description' => t('TRUE if the user is allowed to download datastreams that match this rule FALSE otherwise.'),
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 1,
      ),
    ),
    'primary key' => array('id'),
    'unique keys' => array(
      'pid' => array('pid')
    ),
  );
  return $schema;
}
Something went wrong with that request. Please try again.