Api

Version

mediamosa-30

Class

mediamosa_rest_call_job_asset_search

Code

File: /sites/all/modules/mediamosa/modules/job/mediamosa_job.rest.class.inc
<?php

/**
 * URI: /asset/$asset_id/joblist
 * Method: GET
 *
 * Return list of jobs based on asset_id
 *
 * 1.x: vpx_jobscheduler_get_asset_job_list
 *
 */
class mediamosa_rest_call_job_asset_search extends mediamosa_rest_call {
  // ------------------------------------------------------------------- Consts.
  // Rest vars;
  const USER_ID = 'user_id';
  const ASSET_ID = 'asset_id';
  const CQL = 'cql';

  // ------------------------------------------------------------ Get Var Setup.
  public function get_var_setup() {
    $var_setup = array();

    $var_setup = array(
      self::VARS => array(
        self::USER_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_USER_ID,
          self::VAR_DESCRIPTION => 'The user ID for owner.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
        self::ASSET_ID => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_ASSET_ID,
          self::VAR_DESCRIPTION => 'The asset ID to search on.',
          self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
        ),
        self::CQL => array(
          self::VAR_TYPE => mediamosa_sdk::TYPE_CQL_JOB,
          self::VAR_DESCRIPTION => 'The CQL search string, used for extended and complex search options.',
        ),
      )
    );

    // Set limit and offset.
    $var_setup = self::get_var_setup_range($var_setup, mediamosa_settings::LIMIT_MAX_JOBLIST, mediamosa_settings::LIMIT_DEFAULT_JOBLIST);

    // Enrich with required REST vars.
    return self::get_var_setup_default($var_setup);
  }

  // ---------------------------------------------- Override Validate Rest Args.
  // Override for checking CQL string.
  protected function validate_rest_args(array $var_setup) {

    // Validate first.
    parent::validate_rest_args($var_setup);

    $cql = $this->get_param_value(self::CQL);
    $app_ids = $this->get_param_value_app();
    $error_text = '';

    if ($cql != '' && !mediamosa_core_cql::verify_job($cql, $app_ids, $error_text)) {
      throw new mediamosa_exception_error(mediamosa_error::ERRORCODE_CQL_ERROR, array('@error' => $error_text));
    }
  }

  // ------------------------------------------------------------------ Do Call.
  public function do_call() {
    $mediamosa = mediamosa::get();

    $is_app_admin = $this->get_param_value(self::IS_APP_ADMIN);
    $a_app_ids = $this->get_param_value_app();
    $first_app_id = reset($a_app_ids);

    $user_id = $this->get_param_value(self::USER_ID);
    $asset_id = $this->get_param_value(self::ASSET_ID);
    $cql = $this->get_param_value(self::CQL);
    $limit = $this->get_param_value_limit();
    $offset =  $this->get_param_value_offset();

    // Must exist.
    $asset = mediamosa_db::db_must_exists(mediamosa_asset_db::TABLE_NAME, array(mediamosa_asset_db::ID => $asset_id));

    // We show all data is it is app_admin or first element in application ID array is zero.
    $is_full_access = $is_app_admin || ($first_app_id == 0);

    // @todo: if app have no access at all we just return empty list now. If exception needed - add it here.
    // mediamosa_acl::owner_check was here earlier.
    // mediamosa_aut::owner_check($app_id, $user_id, $asset[mediamosa_asset_db::APP_ID], $asset[mediamosa_asset_db::OWNER_ID], $is_app_admin);

    $item_count_total = NULL;

    // Get the jobs from the user.
    $result = mediamosa_job::get_job_list($a_app_ids, $user_id, $is_full_access, FALSE, $asset_id, '', $cql, $limit, $offset);

    // Get the count.
    $mediamosa->item_count_total = $result->found_rows;

    foreach ($result as $a_row) {
      $started_unix = isset($a_row[mediamosa_job_db::STARTED]) ? mediamosa_lib::iso8601date_to_unix($a_row[mediamosa_job_db::STARTED]) : '';

      $a_job = array();

      $a_job['id'] = $a_row[mediamosa_job_db::ID];
      $a_job['owner'] = $a_row[mediamosa_job_db::OWNER_ID];
      $a_job['status'] = $a_row[mediamosa_job_db::JOB_STATUS];
      $a_job['progress'] = $a_row[mediamosa_job_db::PROGRESS];
      $a_job['priority'] = $a_row[mediamosa_job_db::PRIORITY];
      $a_job['job_type'] = $a_row[mediamosa_job_db::JOB_TYPE];
      $a_job['started'] = $started_unix ? format_date($started_unix, 'custom', 'd-m-Y H:i') : '';
      $a_job['started_unix'] = $started_unix;
      $a_job['error_description'] = $a_row[mediamosa_job_db::ERROR_DESCRIPTION];

      $mediamosa->add_item($a_job);
    }
  }
}