You are here

Home » API reference » Services 7.3

services.install in Services 7.3

Same filename and directory in other branches
  1. 8.4 services.install
  2. 5 services.install
  3. 6.3 services.install
  4. 6 services.install
  5. 6.2 services.install
  6. 7 services.install
  7. 9.0.x services.install

Install, uninstall and update the Services module.

File

services.install
View source 
<?php

/**
 * @file
 * Install, uninstall and update the Services module.
 */

/**
 * Implements hook_schema().
 */
function services_schema() {
  $schema = array();
  $schema['services_endpoint'] = array(
    'description' => 'Stores endpoint information for services',
    'fields' => array(
      'eid' => array(
        'type' => 'serial',
        'description' => 'Primary ID field for the table. Not used for anything except internal lookups.',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'no export' => TRUE,
      ),
      'name' => array(
        'description' => 'The name of the endpoint.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
      'server' => array(
        'description' => 'The name of the server used in this endpoint.',
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
      ),
      'path' => array(
        'description' => 'The path to the endpoint for this server.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
      'authentication' => array(
        'description' => 'The authentication settings for the endpoint.',
        'type' => 'text',
        'size' => 'big',
        'not null' => TRUE,
        'serialize' => TRUE,
        'object default' => array(),
      ),
      'server_settings' => array(
        'description' => 'The server settings for the endpoint.',
        'type' => 'blob',
        'size' => 'big',
        'not null' => TRUE,
        'serialize' => TRUE,
      ),
      'resources' => array(
        'description' => 'Information about the resources exposed in this endpoint.',
        'type' => 'text',
        'size' => 'big',
        'not null' => TRUE,
        'serialize' => TRUE,
        'object default' => array(),
      ),
      'debug' => array(
        'description' => 'Set the endpoint in debug mode.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array(
      'eid',
    ),
    'unique keys' => array(
      'name' => array(
        'name',
      ),
    ),
    'export' => array(
      'key' => 'name',
      'identifier' => 'endpoint',
      'primary key' => 'name',
      'api' => array(
        'owner' => 'services',
        'api' => 'services',
        'minimum_version' => 3,
        'current_version' => 3,
      ),
    ),
  );
  $schema['services_user'] = array(
    'description' => 'Stores users created/updated by services.',
    'fields' => array(
      'uid' => array(
        'type' => 'int',
        'description' => 'User id that has been created by Drupal',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'created' => array(
        'description' => 'The Unix timestamp when the node was most recently created by services.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'changed' => array(
        'description' => 'The Unix timestamp when the user was most recently updated by services.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array(
      'uid',
    ),
  );
  return $schema;
}

/**
 * Implements hook_requirements().
 */
function services_requirements($phase) {
  $requirements = array();
  $t = get_t();

  // Warn users of the possible threat.
  if ($phase == 'runtime') {

    //Pull endpoints that do not have services authentication enabled
    module_load_include('module', 'services');
    $endpoints = services_endpoint_load_all();
    $items = array();

    // Build our items array
    foreach ($endpoints as $endpoint) {
      if (empty($endpoint->disabled) && empty($endpoint->authentication)) {
        $items[] = l($endpoint->name, 'admin/structure/services/list/' . $endpoint->name . '/edit');
      }
    }

    // theme the endpoints list
    $endpoints = '';
    if (!empty($items)) {
      $endpoints = theme('item_list', array(
        'items' => $items,
      ));
    }

    // Only display the list if we have at least one endpoint without services authentication.
    if (count($items)) {
      $requirements['services'] = array(
        'description' => $t('Services authentication mechanism has not been enabled for the following endpoints. Requests to these endpoints will always be anonymous.'),
        'severity' => REQUIREMENT_WARNING,
        'value' => $endpoints,
        'title' => 'Services Authentication Mechanism',
      );
    }
    else {
      $requirements['services'] = array(
        'severity' => REQUIREMENT_OK,
        'value' => 'Enabled for all Endpoints',
        'title' => 'Services Authentication Mechanism',
      );
    }
    $services_security_update = variable_get('services_security_update_1', FALSE);
    if (!$services_security_update) {
      $url = url('admin/config/services/services-security');
      $requirements['services'] = array(
        'description' => $t('Services has issued a security update with the most recent module release. Administrative steps are required to secure your Drupal installation <a href="!url">here</a>.', array(
          '!url' => $url,
        )),
        'severity' => REQUIREMENT_ERROR,
        'value' => 'Steps needed',
        'title' => 'Services Authentication Mechanism',
      );
    }
  }
  return $requirements;
}

/**
 * Implements hook_install().
 */
function services_install() {
  $ret = array();

  //Set our security update to true since it wont need to be displayed

  //on the status report page
  variable_set('services_security_update_1', TRUE);
}

/**
 * Implements hook_uninstall().
 */
function services_uninstall() {
  $ret = array();

  // Drop legacy tables
  $legacy_tables = array(
    'services_keys',
    'services_timestamp_nonce',
  );
  foreach ($legacy_tables as $table) {
    if (db_table_exists($table)) {
      db_drop_table($ret, $table);
    }
  }
  variable_del('services_use_key');
  variable_del('services_use_sessid');
  variable_del('services_debug');
  variable_del('services_auth_module');
}

/**
 * Update 7301 adds debugging to each endopint to facilitate easier development
 */
function services_update_7301() {
  $table = 'services_endpoint';
  foreach (array(
    'debug' => 0,
    'status' => 1,
  ) as $field => $value) {
    if (!db_field_exists($table, $field)) {
      db_add_field($table, $field, array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => $value,
      ));
    }
  }
}

/**
 * Update 7302 restores the usage of Chaos tools to check for enable/disable-status
 */
function services_update_7302() {
  $table = 'services_endpoint';
  if (db_field_exists($table, 'status')) {
    db_drop_field($table, 'status');
  }
}

/**
 * Update 7303 adds the possibility to configure server settings on a per-endpoint basis.
 * and sets upgrades all new servers to have at least services session enabled.
 */
function services_update_7303() {

  // Add the new server settings field.
  if (!db_field_exists('services_endpoint', 'server_settings')) {
    db_add_field('services_endpoint', 'server_settings', array(
      'description' => 'The server settings for the endpoint.',
      'type' => 'blob',
      'size' => 'big',
      'not null' => TRUE,
      'serialize' => TRUE,
      'initial' => '',
    ));
  }

  // Fetch all endpoints that currently exist
  $result = db_select('services_endpoint', 'se')
    ->fields('se')
    ->execute()
    ->fetchAll();

  // Loop through every endpoint and update the authentication section.
  // Note, this will not remove previous authentication settings, it will
  // only add to them.
  foreach ($result as $services_endpoint_object) {
    $new_authentication = array(
      'services' => 'services',
    );
    $unserial_endpoint_settings = unserialize($services_endpoint_object->authentication);
    db_update('services_endpoint')
      ->fields(array(
      'authentication' => serialize(array_merge($unserial_endpoint_settings, $new_authentication)),
    ))
      ->condition('eid', $services_endpoint_object->eid)
      ->execute();
  }
}

/**
 * Update 7304 removes the title as it is no longer used
 */
function services_update_7399() {
  $table = 'services_endpoint';
  if (db_field_exists($table, 'title')) {
    db_drop_field($table, 'title');
  }
}

/**
 * Update 7400 reduces nesting in the way server settings are stored
 */
function services_update_7400() {
  module_load_include('module', 'services');
  $server_names = array_keys(services_get_servers());
  foreach (services_endpoint_load_all() as $endpoint) {
    $settings = $endpoint->server_settings;
    if (!empty($settings)) {
      if (in_array(key($settings), $server_names)) {
        $settings = current($settings);
      }
    }
    else {
      $settings = array();
    }
    $endpoint->server_settings = $settings;
    services_endpoint_save($endpoint);
  }
}

/**
 * Update 7402 adds services_user table so that services can see users created/update by itself.
 */
function services_update_7402() {
  $schema['services_user'] = array(
    'description' => 'Stores users created/updated by services.',
    'fields' => array(
      'uid' => array(
        'type' => 'int',
        'description' => 'User id that has been created by Drupal',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'created' => array(
        'description' => 'The Unix timestamp when the node was most recently created by services.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'changed' => array(
        'description' => 'The Unix timestamp when the user was most recently updated by services.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
  );
  db_create_table('services_user', $schema['services_user']);
}

/**
 * Add primary key to the services_user table, truncating it first
 */
function services_update_7403() {

  // We have to truncate the table because the table was wrongly
  // updating every single record
  db_truncate('services_user')
    ->execute();
  db_add_primary_key('services_user', array(
    'uid',
  ));
}

Functions

Namesort descending Description
services_install Implements hook_install().
services_requirements Implements hook_requirements().
services_schema Implements hook_schema().
services_uninstall Implements hook_uninstall().
services_update_7301 Update 7301 adds debugging to each endopint to facilitate easier development
services_update_7302 Update 7302 restores the usage of Chaos tools to check for enable/disable-status
services_update_7303 Update 7303 adds the possibility to configure server settings on a per-endpoint basis. and sets upgrades all new servers to have at least services session enabled.
services_update_7399 Update 7304 removes the title as it is no longer used
services_update_7400 Update 7400 reduces nesting in the way server settings are stored
services_update_7402 Update 7402 adds services_user table so that services can see users created/update by itself.
services_update_7403 Add primary key to the services_user table, truncating it first