Api
Version
mediamosa-30Class
mediamosa_rest_call_acl_mediafile_set_rightsCode
File: /sites/all/modules/mediamosa/modules/acl/mediamosa_acl.rest.class.inc
<?php
/**
* URI: /mediafile/$mediafile_id/acl
* Method: POST
*/
class mediamosa_rest_call_acl_mediafile_set_rights extends mediamosa_rest_call {
// ------------------------------------------------------------------- Consts.
// Rest vars;
const MEDIAFILE_ID = 'mediafile_id';
const USER_ID = 'user_id';
const REPLACE = 'replace';
const ACL_APP = 'acl_app';
const ACL_USER = 'acl_user';
const ACL_GROUP = 'acl_group';
const ACL_DOMAIN = 'acl_domain';
const ACL_REALM = 'acl_realm';
const ACL_USER_ID = 'acl_user_id';
const ACL_GROUP_ID = 'acl_group_id';
// Aliases, do NOT use in code(!).
const ALIAS_AUT_APP = 'aut_app';
const ALIAS_AUT_USER = 'aut_user';
const ALIAS_AUT_GROUP = 'aut_group';
const ALIAS_AUT_DOMAIN = 'aut_domain';
const ALIAS_AUT_REALM = 'aut_realm';
const ALIAS_AUT_USER_ID = 'aut_user_id';
const ALIAS_AUT_GROUP_ID = 'aut_group_id';
// ------------------------------------------------------- Functions (public).
public function get_var_setup() {
$var_setup = array();
$var_setup[self::VARS][self::MEDIAFILE_ID] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_MEDIAFILE_ID,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
self::VAR_DESCRIPTION => 'The mediafile ID of which to change the rights.',
);
$var_setup[self::VARS][self::USER_ID] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_USER_ID,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
self::VAR_DESCRIPTION => 'Must match the owner fo the mediafile.',
);
$var_setup[self::VARS][self::REPLACE] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_BOOL,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_DEFAULT_VALUE => 'TRUE',
self::VAR_DESCRIPTION => "'TRUE' of 'FALSE' if the current right has to be replaced. Standard is TRUE. Define if 'FALSE' if you want to keep the old rights.",
);
$var_setup[self::VARS][self::ACL_APP] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'Application(s) that gain access to the mediafile.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_APP),
);
$var_setup[self::VARS][self::ACL_USER] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_USER_ID,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'User(s) that gain access to the mediafile.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_USER),
);
$var_setup[self::VARS][self::ACL_GROUP] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_GROUP_ID,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'Group(s) that gain access to the mediafile.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_GROUP),
);
$var_setup[self::VARS][self::ACL_DOMAIN] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_DOMAIN,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'Domain(s) that gain access to the mediafile.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_DOMAIN),
);
$var_setup[self::VARS][self::ACL_REALM] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_REALM,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'Realm(s) that gain access to the mediafile.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_REALM),
);
// alias.
$var_setup[self::VARS][self::ACL_USER_ID] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_USER_ID,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'Alias of acl_user.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_USER_ID),
);
// alias.
$var_setup[self::VARS][self::ACL_GROUP_ID] = array(
self::VAR_TYPE => mediamosa_sdk::TYPE_GROUP_ID,
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
self::VAR_IS_ARRAY => self::VAR_IS_ARRAY_YES,
self::VAR_DESCRIPTION => 'Alias of acl_group.',
self::VAR_DEFAULT_VALUE => array(),
self::VAR_ALIAS_FOR => array(self::ALIAS_AUT_GROUP_ID),
);
// Enrich with required REST vars.
return self::get_var_setup_default($var_setup);
}
public function do_call() {
$mediamosa = mediamosa::get();
// Get the app id(s).
$app_ids = $this->get_param_value_app();
$mediafile_id = $this->get_param_value('mediafile_id');
$user_id = $this->get_param_value('user_id');
// First is always the main app.
$app_id = reset($app_ids);
// Make sure the media file exists.
mediamosa_asset_mediafile::must_exists($mediafile_id, $app_id);
$app_ids = $this->get_param_value('acl_app');
$a_acl_user_ids = $this->get_param_value('acl_user');
$a_acl_group_ids = $this->get_param_value('acl_group');
$a_acl_domains = $this->get_param_value('acl_domain');
$a_acl_realms = $this->get_param_value('acl_realm');
$b_replace = $this->get_param_value('replace');
// Get the media file.
$a_mediafile = mediamosa_asset_mediafile::get($mediafile_id, $app_id);
// Fix for difference in acl_user and acl_user_id
if (!count($a_acl_user_ids)) {
// Hmmm no a_acl_user_ids, then try acl_user_id and set user_id if we find one
$a_acl_user_ids = $this->get_param_value('acl_user_id');
$this->set_param_value('acl_user', $a_acl_user_ids);
}
else {
$this->set_param_value('acl_user_id', $a_acl_user_ids);
}
if (!count($a_acl_group_ids)) {
// Hmmm no a_acl_group_ids, then try acl_group_id and set group_id if we find one
$a_acl_group_ids = $this->get_param_value('acl_group_id');
$this->set_param_value('acl_group', $a_acl_group_ids);
}
else {
$this->set_param_value('acl_group_id', $a_acl_group_ids);
}
// Set access rights
$result_rights_set = mediamosa_acl::rights_set($app_id, $user_id, mediamosa_acl::ACL_TYPE_MEDIAFILE, $a_mediafile, $app_ids, $a_acl_user_ids, $a_acl_group_ids, $a_acl_domains, $a_acl_realms, $b_replace);
if (mediamosa::is_v3_output()) {
$types = array(
mediamosa_acl::ACL_NAME_TYPE_APP => 'acl_app',
mediamosa_acl::ACL_NAME_TYPE_USER => 'acl_user',
mediamosa_acl::ACL_NAME_TYPE_USER_GROUP => 'acl_group',
mediamosa_acl::ACL_NAME_TYPE_DOMAIN => 'acl_domain',
mediamosa_acl::ACL_NAME_TYPE_REALM => 'acl_realm',
);
}
else {
$types = array(
mediamosa_acl::ACL_NAME_TYPE_APP => 'aut_app',
mediamosa_acl::ACL_NAME_TYPE_USER => 'aut_user',
mediamosa_acl::ACL_NAME_TYPE_USER_GROUP => 'aut_group',
mediamosa_acl::ACL_NAME_TYPE_DOMAIN => 'aut_domain',
mediamosa_acl::ACL_NAME_TYPE_REALM => 'aut_realm',
);
}
foreach ($result_rights_set as $error) {
$type = (isset($types[$error['type']]) ? $types[$error['type']] : 'unknown');
if ($error['a_error'] === FALSE) {
$mediamosa->add_item(
array(
$type => array(
'value' => $error['value'],
'result' => mediamosa_response::SUCCESS,
'result_id' => mediamosa_error::ERRORCODE_OKAY,
'result_description' => mediamosa_error::error_code_find_description(mediamosa_error::ERRORCODE_OKAY),
)
)
);
}
else {
$mediamosa->add_item(
array(
$type => array(
'value' => $error['value'],
'result' => mediamosa_response::ERROR,
'result_id' => $error['a_error']['code'],
'result_description' => $error['a_error']['message'],
)
)
);
}
}
}
}
