You are here

Home » API reference » Ubercart 6.2

uc_file.install in Ubercart 6.2

Same filename and directory in other branches
  1. 8.4 uc_file/uc_file.install
  2. 5 uc_file/uc_file.install
  3. 7.3 uc_file/uc_file.install

Install, update and uninstall functions for the uc_file module.

File

uc_file/uc_file.install
View source 
<?php

/**
 * @file
 * Install, update and uninstall functions for the uc_file module.
 */

// -1 is the UC_FILE_LIMIT_SENTINEL constant in uc_file.module, but
// it might not be available (like when upgrading from 5 -> 6.

/**
 * Implements hook_schema().
 */
function uc_file_schema() {
  $schema = array();
  $schema['uc_files'] = array(
    'description' => 'Stores information on purchasable files.',
    'fields' => array(
      'fid' => array(
        'description' => 'Primary key: the file ID.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'filename' => array(
        'description' => 'The name of the file.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'primary key' => array(
      'fid',
    ),
    'indexes' => array(
      'filename' => array(
        'filename',
      ),
    ),
  );
  $schema['uc_file_products'] = array(
    'description' => 'Maps file product features to files.',
    'fields' => array(
      'fpid' => array(
        'description' => 'Primary key: the ID for the file-product combination.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'pfid' => array(
        'description' => 'The {uc_product_features}.pfid.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'fid' => array(
        'description' => 'The {uc_files}.fid of the purchasable file.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'model' => array(
        'description' => 'The product model.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ),
      'description' => array(
        'description' => 'The description of the file.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ),
      'shippable' => array(
        'description' => 'Is this file feature shippable? 1 => Yes. 0 => No.',
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 0,
      ),
      'download_limit' => array(
        'description' => 'The number of times the file may be downloaded by a user. -1 indicates the store default will be used.',
        'type' => 'int',
        'not null' => FALSE,
        'default' => -1,
      ),
      'address_limit' => array(
        'description' => 'The number of different IP addresses from which the file may be downloaded. -1 indicates the store default will be used.',
        'type' => 'int',
        'not null' => FALSE,
        'default' => -1,
      ),
      'time_granularity' => array(
        'description' => 'The units of time for time_quantity. -1 indicates the store default will be used.',
        'type' => 'varchar',
        'length' => 16,
        'not null' => TRUE,
        'default' => '-1',
      ),
      'time_quantity' => array(
        'description' => 'With time_granularity, the amount of time the file will be available for download. -1 indicates the store default will be used.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => -1,
      ),
    ),
    'indexes' => array(
      'pfid' => array(
        'pfid',
      ),
      'fid' => array(
        'fid',
      ),
    ),
    'primary key' => array(
      'fpid',
    ),
  );
  $schema['uc_file_users'] = array(
    'description' => 'The customers and the files they have purchased.',
    'fields' => array(
      'fuid' => array(
        'description' => 'Primary key: the ID of the file-user combination.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'fid' => array(
        'description' => 'The {uc_files}.fid that was purchased.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'uid' => array(
        'description' => 'The {users}.uid of the user who purchased the file.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'pfid' => array(
        'description' => 'The product feature ID of the product that was ordered, from {uc_file_products}.pfid.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => FALSE,
      ),
      'file_key' => array(
        'description' => 'A hash of the data in this row.',
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => '',
      ),
      'granted' => array(
        'description' => 'The Unix timestamp indicating when the file was made available for download.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'expiration' => array(
        'description' => 'The Unix timestamp indicating when the file will no longer be available for download.',
        'type' => 'int',
        'not null' => FALSE,
        'default' => 0,
      ),
      'accessed' => array(
        'description' => 'The number of times the file has been downloaded by the user.',
        'type' => 'int',
        'size' => 'small',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'addresses' => array(
        'description' => 'The number of different IP addresses the user has used to download the file.',
        'type' => 'text',
        'serialize' => TRUE,
        'not null' => FALSE,
      ),
      'download_limit' => array(
        'description' => 'The number of times the user may download the file.',
        'type' => 'int',
        'not null' => FALSE,
        'default' => NULL,
      ),
      'address_limit' => array(
        'description' => 'The number of different IP addresses the user may use to download the file.',
        'type' => 'int',
        'not null' => FALSE,
        'default' => NULL,
      ),
    ),
    'indexes' => array(
      'fid' => array(
        'fid',
      ),
      'uid' => array(
        'uid',
      ),
    ),
    'primary key' => array(
      'fuid',
    ),
  );
  return $schema;
}

/**
 * Implements hook_install().
 */
function uc_file_install() {
  drupal_install_schema('uc_file');
}

/**
 * Implements hook_uninstall().
 */
function uc_file_uninstall() {
  drupal_uninstall_schema('uc_file');
  db_query("DELETE FROM {uc_product_features} WHERE fid = 'file'");
  db_query("DELETE FROM {variable} WHERE name LIKE 'uc_file_%%'");
}

/**
 * Implements hook_update_last_removed().
 */
function uc_file_update_last_removed() {
  return 4;
}
function uc_file_update_6000() {
  $ret = array();
  db_drop_index($ret, 'uc_files', 'fid');
  db_change_field($ret, 'uc_files', 'fid', 'fid', array(
    'type' => 'serial',
    'unsigned' => TRUE,
    'not null' => TRUE,
  ), array(
    'primary key' => array(
      'fid',
    ),
  ));
  db_drop_index($ret, 'uc_file_products', 'pfid');
  db_drop_index($ret, 'uc_file_products', 'fid');
  db_change_field($ret, 'uc_file_products', 'pfid', 'pfid', array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => TRUE,
    'default' => 0,
  ), array(
    'indexes' => array(
      'pfid' => array(
        'pfid',
      ),
    ),
  ));
  db_change_field($ret, 'uc_file_products', 'fid', 'fid', array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => TRUE,
    'default' => 0,
  ), array(
    'indexes' => array(
      'fid' => array(
        'fid',
      ),
    ),
  ));
  db_change_field($ret, 'uc_file_products', 'shippable', 'shippable', array(
    'type' => 'int',
    'size' => 'tiny',
    'not null' => TRUE,
    'default' => 0,
  ));
  db_drop_index($ret, 'uc_file_users', 'fid');
  db_drop_index($ret, 'uc_file_users', 'uid');
  db_change_field($ret, 'uc_file_users', 'fid', 'fid', array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => TRUE,
    'default' => 0,
  ), array(
    'indexes' => array(
      'fid' => array(
        'fid',
      ),
    ),
  ));
  db_change_field($ret, 'uc_file_users', 'uid', 'uid', array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => TRUE,
    'default' => 0,
  ), array(
    'indexes' => array(
      'uid' => array(
        'uid',
      ),
    ),
  ));
  db_change_field($ret, 'uc_file_users', 'pfid', 'pfid', array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => FALSE,
  ));
  return $ret;
}
function uc_file_update_6001() {
  $ret = array();
  $new_field = array(
    'type' => 'varchar',
    'length' => 32,
    'not null' => TRUE,
    'default' => '',
  );

  // change the key field to something less conflicting...
  if (db_column_exists('uc_file_users', 'key')) {

    // workaround for Drupal limitation
    if ($GLOBALS['db_type'] == 'mysql' || $GLOBALS['db_type'] == 'mysqli') {
      $field = '`key`';
    }
    else {
      $field = 'key';
    }
    db_change_field($ret, 'uc_file_users', $field, 'file_key', $new_field);
  }
  return $ret;
}

/**
 * Add primary keys to file_products and file_users.
 */
function uc_file_update_6002() {
  $ret = array();
  $new_field = array(
    'type' => 'serial',
    'unsigned' => TRUE,
    'not null' => TRUE,
  );
  db_add_field($ret, 'uc_file_users', 'fuid', $new_field, array(
    'primary key' => array(
      'fuid',
    ),
  ));
  db_add_field($ret, 'uc_file_products', 'fpid', $new_field, array(
    'primary key' => array(
      'fpid',
    ),
  ));
  return $ret;
}

/**
 * Make sure the quantity is validated.
 */
function uc_file_update_6003() {
  if (variable_get('uc_file_download_limit_duration_granularity', 'never') != 'never' && variable_get('uc_file_download_limit_duration_qty', NULL) == NULL) {
    variable_set('uc_file_download_limit_duration_qty', 1);
  }
  return array();
}

/**
 * Add per-file limits.
 */
function uc_file_update_6004() {
  $ret = array();
  $integer_field = array(
    'type' => 'int',
    'not null' => FALSE,
    'default' => -1,
  );
  $null_integer_field = array(
    'type' => 'int',
    'not null' => FALSE,
    'default' => NULL,
  );
  $string_field = array(
    'type' => 'varchar',
    'length' => 16,
    'not null' => TRUE,
    'default' => '-1',
  );

  // Add the per-file limit data.
  db_add_field($ret, 'uc_file_products', 'download_limit', $integer_field);
  db_add_field($ret, 'uc_file_products', 'address_limit', $integer_field);
  db_add_field($ret, 'uc_file_products', 'time_granularity', $string_field);
  db_add_field($ret, 'uc_file_products', 'time_quantity', $integer_field);

  // Add the per-user db data.
  db_add_field($ret, 'uc_file_users', 'download_limit', $null_integer_field);
  db_add_field($ret, 'uc_file_users', 'address_limit', $null_integer_field);
  db_add_field($ret, 'uc_file_users', 'expiration', $null_integer_field);
  return $ret;
}

/**
 * Iterate over all the existing file_user objects and replace them with the
 * defaults for their product feature.
 */
function uc_file_update_6005(&$sandbox) {
  $ret = array();
  if (!isset($sandbox['progress'])) {
    $sandbox['progress'] = 0;
    $sandbox['current_fuid'] = 0;
    $sandbox['max'] = db_result(db_query('SELECT COUNT(DISTINCT fuid) FROM {uc_file_users}'));
  }

  // This could probably go higher, but this will be fine for now.
  $limit = 100;
  $result = db_query_range("SELECT * FROM {uc_file_users} WHERE fuid > %d ORDER BY fuid ASC", $sandbox['current_fuid'], 0, $limit);
  while ($file_user = db_fetch_object($result)) {
    $file_product = db_fetch_object(db_query("SELECT * FROM {uc_file_products} WHERE pfid = %d", $file_user->pfid));

    // Get the higher limits. Work around the 5 -> 6 upgrade path.
    if (function_exists('uc_file_get_download_limit') && $file_product) {
      $file_user->download_limit = uc_file_get_download_limit($file_product);
      $file_user->address_limit = uc_file_get_address_limit($file_product);
      $time_limit = uc_file_get_time_limit($file_product);
    }
    else {
      $file_user->download_limit = variable_get('uc_file_download_limit_number', NULL);
      $file_user->address_limit = variable_get('uc_file_download_limit_addresses', NULL);
      $time_limit = array(
        'time_polarity' => '+',
        'time_granularity' => variable_get('uc_file_download_limit_duration_granularity', 'never'),
        'time_quantity' => variable_get('uc_file_download_limit_duration_qty', NULL),
      );
    }
    $granted = $file_user->granted;
    if ($time_limit['time_polarity'] == 'never') {
      $expiration = NULL;
    }
    else {
      $expiration = strtotime($time_limit['time_polarity'] . $time_limit['time_quantity'] . ' ' . $time_limit['time_granularity'], $file_user->granted);
    }

    // drupal_write_record() doesn't work here for some odd reason.
    db_query("UPDATE {uc_file_users} SET expiration = %d WHERE fuid = %d", $expiration, $file_user->fuid);
    $sandbox['progress']++;
    $sandbox['current_fuid'] = $file_user->fuid;
  }
  $ret['#finished'] = empty($sandbox['max']) ? 1 : $sandbox['progress'] / $sandbox['max'];
  return $ret;
}

/**
 * Fix double serialization in addresses column.
 */
function uc_file_update_6006(&$sandbox) {
  $ret = array();
  if (!isset($sandbox['progress'])) {
    $sandbox['progress'] = 0;
    $sandbox['current_fuid'] = 0;
    $sandbox['max'] = db_result(db_query('SELECT COUNT(DISTINCT fuid) FROM {uc_file_users}'));
  }
  $limit = 100;
  $result = db_query_range("SELECT * FROM {uc_file_users} WHERE fuid > %d ORDER BY fuid ASC", $sandbox['current_fuid'], 0, $limit);
  while ($file_user = db_fetch_object($result)) {
    $addresses = $file_user->addresses;
    $i = 0;
    while (is_string($addresses)) {
      $addresses = unserialize($addresses);
      $i++;
    }
    if (is_array($addresses) && $i > 1) {
      $file_user->addresses = serialize($addresses);
      db_query("UPDATE {uc_file_users} SET addresses = '%s' WHERE fuid = %d", $file_user->addresses, $file_user->fuid);
    }
    $sandbox['progress']++;
    $sandbox['current_fuid'] = $file_user->fuid;
  }
  $ret['#finished'] = empty($sandbox['max']) ? 1 : $sandbox['progress'] / $sandbox['max'];
  return $ret;
}

/**
 * Add a index on filename since we query on it fairly frequently.
 */
function uc_file_update_6007() {
  $ret = array();
  db_add_index($ret, 'uc_files', 'filename', array(
    'filename',
  ));
  return $ret;
}

Functions

Namesort descending Description
uc_file_install Implements hook_install().
uc_file_schema Implements hook_schema().
uc_file_uninstall Implements hook_uninstall().
uc_file_update_6000
uc_file_update_6001
uc_file_update_6002 Add primary keys to file_products and file_users.
uc_file_update_6003 Make sure the quantity is validated.
uc_file_update_6004 Add per-file limits.
uc_file_update_6005 Iterate over all the existing file_user objects and replace them with the defaults for their product feature.
uc_file_update_6006 Fix double serialization in addresses column.
uc_file_update_6007 Add a index on filename since we query on it fairly frequently.
uc_file_update_last_removed Implements hook_update_last_removed().