path: root/Zotlabs/Lib/Permcat.php

<?php

namespace Zotlabs\Lib;

use Zotlabs\Access\PermissionRoles;
use Zotlabs\Access\Permissions;
use Zotlabs\Daemon\Master;

/**
 * @brief Permission Categories. Permission rules for various classes of connections.
 *
 * Connection permissions answer the question "Can Joe view my photos?"
 *
 * Some permissions may be inherited from the channel's "privacy settings"
 * (@ref ::Zotlabs::Access::PermissionLimits "PermissionLimits") "Who can view my
 * photos (at all)?" which have higher priority than individual connection settings.
 * We evaluate permission limits first, and then fall through to connection
 * permissions if the permission limits didn't already make a definitive decision.
 *
 * After PermissionLimits and connection permissions are evaluated, individual
 * content ACLs are evaluated (@ref ::Zotlabs::Access::AccessList "AccessList").
 * These answer the question "Can Joe view *this* album/photo?".
 */
class Permcat {

	/**
	 * @var array
	 */
	private $permcats = [];

	/**
	 * @brief Permcat constructor.
	 *
	 * @param int $channel_id
	 */
	public function __construct($channel_id) {

		$perms = [];

		// first check role perms for a perms_connect setting

		$role = get_pconfig($channel_id, 'system', 'permissions_role');
		if ($role) {
			$x = PermissionRoles::role_perms($role);
			if ($x['perms_connect']) {
				$perms = Permissions::FilledPerms($x['perms_connect']);
			}
		}

		// if no role perms it may be a custom role, see if there any autoperms

		if (!$perms) {
			$perms = Permissions::FilledAutoPerms($channel_id);
		}

		// if no autoperms it may be a custom role with manual perms

		if (!$perms) {
			$r = q("select channel_hash from channel where channel_id = %d",
				intval($channel_id)
			);
			if ($r) {
				$x = q("select * from abconfig where chan = %d and xchan = '%s' and cat = 'my_perms'",
					intval($channel_id),
					dbesc($r[0]['channel_hash'])
				);
				if ($x) {
					foreach ($x as $xv) {
						$perms[$xv['k']] = intval($xv['v']);
					}
				}
			}
		}

		// nothing was found - create a filled permission array where all permissions are 0

		if (!$perms) {
			$perms = Permissions::FilledPerms([]);
		}

		$this->permcats[] = [
			'name'      => 'default',
			'localname' => t('Default', 'permcat'),
			'perms'     => Permissions::Operms($perms),
			'raw_perms' => $perms,
			'system'    => 1
		];


		$p = $this->load_permcats($channel_id);
		if ($p) {
			for ($x = 0; $x < count($p); $x++) {
				$this->permcats[] = [
					'name'      => $p[$x][0],
					'localname' => $p[$x][1],
					'perms'     => Permissions::Operms(Permissions::FilledPerms($p[$x][2])),
					'raw_perms' => Permissions::FilledPerms($p[$x][2]),
					'system'    => intval($p[$x][3])
				];
			}
		}
	}

	/**
	 * @brief Return array with permcats.
	 *
	 * @return array
	 */
	public function listing() {
		return $this->permcats;
	}

	/**
	 * @brief
	 *
	 * @param string $name
	 * @return array
	 *   * \e array with permcats
	 *   * \e bool \b error if $name not found in permcats true
	 */
	public function fetch($name) {
		if ($name && $this->permcats) {
			foreach ($this->permcats as $permcat) {
				if (strcasecmp($permcat['name'], $name) === 0) {
					return $permcat;
				}
			}
		}

		return ['error' => true];
	}

	public function load_permcats($uid) {
		/*
		$permcats = [
			[ 'contributor', t('Contributor','permcat'),
				[ 'view_stream','view_profile','view_contacts','view_storage','view_pages',
				  'write_storage','post_wall','write_pages','write_wiki','post_comments', 'post_mail', 'post_like',
				  'chat' ], 1
			],
			[ 'muted', t('Muted','permcat'),
				[ 'view_stream','view_profile','view_contacts','view_storage','view_pages','view_wiki',
				  'post_comments','write_wiki','post_like' ], 1
			],
		];
		*/
		if ($uid) {
			$x = q("select * from pconfig where uid = %d and cat = 'permcat'",
				intval($uid)
			);

			if ($x) {
				foreach ($x as $xv) {
					$value      = ((preg_match('|^a:[0-9]+:{.*}$|s', $xv['v'])) ? unserialize($xv['v']) : $xv['v']);
					$permcats[] = [$xv['k'], $xv['k'], $value, 0];
				}
			}
		}

		/**
		 * @hooks permcats
		 *   * \e array
		 */
		call_hooks('permcats', $permcats);

		return $permcats;
	}

	static public function find_permcat($arr, $name) {
		if ((!$arr) || (!$name))
			return false;

		foreach ($arr as $p)
			if ($p['name'] == $name)
				return $p['value'];
	}

	static public function update($channel_id, $name, $permarr) {
		PConfig::Set($channel_id, 'permcat', $name, $permarr);
	}

	static public function delete($channel_id, $name) {
		PConfig::Delete($channel_id, 'permcat', $name);
	}

	/**
	 * @brief assign a contact role to contacts
	 *
	 * @param array $channel
	 * @param string $role the name of the role
	 * @param array $contacts an array of contact hashes
	 */
	public static function assign($channel, $role, $contacts) {

		if (!isset($channel['channel_id'])) {
			return;
		}

		if (!is_array($contacts) || empty($contacts)) {
			return;
		}

		if (!$role) {
			// lookup the default
			$role = get_pconfig($channel['channel_id'], 'system', 'default_permcat', 'default');
		}


		// Doublecheck that we do not assign a role to ourself.
		// It does not make a difference but could be confusing.
		if (in_array($channel['channel_hash'], $contacts)) {
			$contacts = array_diff($contacts, [$channel['channel_hash']]);
		}

		$all_perms  = Permissions::Perms();
		$permcats   = new Permcat($channel['channel_id']);
		$role_perms = $permcats->fetch($role);

		if (isset($role_perms['error'])) {
			return false;
		}

		$perms = $role_perms['raw_perms'];

		$values_sql = '';
		stringify_array_elms($contacts, true);

		if ($all_perms && $perms) {

			foreach ($contacts as $contact) {
				foreach ($all_perms as $perm => $desc) {
					if (array_key_exists($perm, $perms)) {
						$values_sql .= " (" . intval($channel['channel_id']) . ", " . protect_sprintf($contact) . ", 'my_perms', '" . dbesc($perm) . "', " . intval($perms[$perm]) . "),";
					}
					else {
						$values_sql .= " (" . intval($channel['channel_id']) . ", " . protect_sprintf($contact) . ", 'my_perms', '" . dbesc($perm) . "', 0), ";
					}
				}
			}
		}

		$values_sql = rtrim($values_sql, ',');

		dbq("DELETE FROM abconfig WHERE chan = " . intval($channel['channel_id']) . " AND cat = 'my_perms' AND xchan IN (" . protect_sprintf(implode(',', $contacts)) . ")");

		dbq("INSERT INTO abconfig ( chan, xchan, cat, k, v ) VALUES $values_sql");

		q("UPDATE abook SET abook_role = '%s'
			WHERE abook_xchan IN (" . protect_sprintf(implode(',', $contacts)) . ") AND abook_channel = %d",
			dbesc($role),
			intval($channel['channel_id'])
		);

		$r = q("SELECT abook.*, xchan.* FROM abook LEFT JOIN xchan ON abook.abook_xchan = xchan.xchan_hash WHERE abook.abook_xchan IN (" . protect_sprintf(implode(',', $contacts)) . ") AND abook.abook_channel = %d AND abook_self = 0",
			intval($channel['channel_id'])
		);

		foreach ($r as $rr) {

			if (intval($rr['abook_self'])) {
				continue;
			}

			Master::Summon([
				'Notifier',
				'permission_update',
				$rr['abook_id']
			]);

			$clone = $rr;

			unset($clone['abook_id']);
			unset($clone['abook_account']);
			unset($clone['abook_channel']);

			$abconfig = load_abconfig($channel['channel_id'], $clone['abook_xchan']);
			if ($abconfig)
				$clone['abconfig'] = $abconfig;

			Libsync::build_sync_packet(0 /* use the current local_channel */, ['abook' => [$clone]]);

		}

		return true;
	}

}