nextcloud / server

apps/testing/lib/AlternativeHomeUserBackend.php

Indentation +18 added lines, -18 removed lines

@@ -34,23 +34,23 @@
  *	]
  */
 class AlternativeHomeUserBackend extends \OC\User\Database {
-	public function __construct() {
-		parent::__construct();
-	}
-	/**
-	 * get the user's home directory
-	 * @param string $uid the username
-	 * @return string|false
-	 */
-	public function getHome($uid) {
-		if ($this->userExists($uid)) {
-			// workaround to avoid killing the admin
-			if ($uid !== 'admin') {
-				$uid = md5($uid);
-			}
-			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
+    public function __construct() {
+        parent::__construct();
+    }
+    /**
+     * get the user's home directory
+     * @param string $uid the username
+     * @return string|false
+     */
+    public function getHome($uid) {
+        if ($this->userExists($uid)) {
+            // workaround to avoid killing the admin
+            if ($uid !== 'admin') {
+                $uid = md5($uid);
+            }
+            return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
 
-		return false;
-	}
+        return false;
+    }
 }

apps/federatedfilesharing/lib/Notifier.php

Indentation +193 added lines, -193 removed lines

@@ -34,197 +34,197 @@
 use OCP\Notification\INotifier;
 
 class Notifier implements INotifier {
-	/** @var IFactory */
-	protected $factory;
-	/** @var IManager */
-	protected $contactsManager;
-	/** @var IURLGenerator */
-	protected $url;
-	/** @var array */
-	protected $federatedContacts;
-	/** @var ICloudIdManager */
-	protected $cloudIdManager;
-
-	/**
-	 * @param IFactory $factory
-	 * @param IManager $contactsManager
-	 * @param IURLGenerator $url
-	 * @param ICloudIdManager $cloudIdManager
-	 */
-	public function __construct(IFactory $factory, IManager $contactsManager, IURLGenerator $url, ICloudIdManager $cloudIdManager) {
-		$this->factory = $factory;
-		$this->contactsManager = $contactsManager;
-		$this->url = $url;
-		$this->cloudIdManager = $cloudIdManager;
-	}
-
-	/**
-	 * @param INotification $notification
-	 * @param string $languageCode The code of the language that should be used to prepare the notification
-	 * @return INotification
-	 * @throws \InvalidArgumentException
-	 */
-	public function prepare(INotification $notification, $languageCode) {
-		if ($notification->getApp() !== 'files_sharing') {
-			// Not my app => throw
-			throw new \InvalidArgumentException();
-		}
-
-		// Read the language from the notification
-		$l = $this->factory->get('files_sharing', $languageCode);
-
-		switch ($notification->getSubject()) {
-			// Deal with known subjects
-			case 'remote_share':
-				$notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg')));
-
-				$params = $notification->getSubjectParameters();
-				if ($params[0] !== $params[1] && $params[1] !== null) {
-					$notification->setParsedSubject(
-						$l->t('You received "%3$s" as a remote share from %1$s (on behalf of %2$s)', $params)
-					);
-					$notification->setRichSubject(
-						$l->t('You received {share} as a remote share from {user} (on behalf of {behalf})'),
-						[
-							'share' => [
-								'type' => 'pending-federated-share',
-								'id' => $notification->getObjectId(),
-								'name' => $params[2],
-							],
-							'user' => $this->createRemoteUser($params[0]),
-							'behalf' => $this->createRemoteUser($params[1]),
-						]
-					);
-				} else {
-					$notification->setParsedSubject(
-						$l->t('You received "%3$s" as a remote share from %1$s', $params)
-					);
-					$notification->setRichSubject(
-						$l->t('You received {share} as a remote share from {user}'),
-						[
-							'share' => [
-								'type' => 'pending-federated-share',
-								'id' => $notification->getObjectId(),
-								'name' => $params[2],
-							],
-							'user' => $this->createRemoteUser($params[0]),
-						]
-					);
-				}
-
-				// Deal with the actions for a known subject
-				foreach ($notification->getActions() as $action) {
-					switch ($action->getLabel()) {
-						case 'accept':
-							$action->setParsedLabel(
-								(string) $l->t('Accept')
-							)
-							->setPrimary(true);
-							break;
-
-						case 'decline':
-							$action->setParsedLabel(
-								(string) $l->t('Decline')
-							);
-							break;
-					}
-
-					$notification->addParsedAction($action);
-				}
-				return $notification;
-
-			default:
-				// Unknown subject => Unknown notification => throw
-				throw new \InvalidArgumentException();
-		}
-	}
-
-	/**
-	 * @param string $cloudId
-	 * @return array
-	 */
-	protected function createRemoteUser($cloudId) {
-		$displayName = $cloudId;
-		try {
-			$resolvedId = $this->cloudIdManager->resolveCloudId($cloudId);
-			$displayName = $this->getDisplayName($resolvedId);
-			$user = $resolvedId->getUser();
-			$server = $resolvedId->getRemote();
-		} catch (HintException $e) {
-			$user = $cloudId;
-			$server = '';
-		}
-
-		return [
-			'type' => 'user',
-			'id' => $user,
-			'name' => $displayName,
-			'server' => $server,
-		];
-	}
-
-	/**
-	 * Try to find the user in the contacts
-	 *
-	 * @param ICloudId $cloudId
-	 * @return string
-	 */
-	protected function getDisplayName(ICloudId $cloudId) {
-		$server = $cloudId->getRemote();
-		$user = $cloudId->getUser();
-		if (strpos($server, 'http://') === 0) {
-			$server = substr($server, strlen('http://'));
-		} else if (strpos($server, 'https://') === 0) {
-			$server = substr($server, strlen('https://'));
-		}
-
-		try {
-			return $this->getDisplayNameFromContact($cloudId->getId());
-		} catch (\OutOfBoundsException $e) {
-		}
-
-		try {
-			$this->getDisplayNameFromContact($user . '@http://' . $server);
-		} catch (\OutOfBoundsException $e) {
-		}
-
-		try {
-			$this->getDisplayNameFromContact($user . '@https://' . $server);
-		} catch (\OutOfBoundsException $e) {
-		}
-
-		return $cloudId->getId();
-	}
-
-	/**
-	 * Try to find the user in the contacts
-	 *
-	 * @param string $federatedCloudId
-	 * @return string
-	 * @throws \OutOfBoundsException when there is no contact for the id
-	 */
-	protected function getDisplayNameFromContact($federatedCloudId) {
-		if (isset($this->federatedContacts[$federatedCloudId])) {
-			if ($this->federatedContacts[$federatedCloudId] !== '') {
-				return $this->federatedContacts[$federatedCloudId];
-			} else {
-				throw new \OutOfBoundsException('No contact found for federated cloud id');
-			}
-		}
-
-		$addressBookEntries = $this->contactsManager->search($federatedCloudId, ['CLOUD']);
-		foreach ($addressBookEntries as $entry) {
-			if (isset($entry['CLOUD'])) {
-				foreach ($entry['CLOUD'] as $cloudID) {
-					if ($cloudID === $federatedCloudId) {
-						$this->federatedContacts[$federatedCloudId] = $entry['FN'];
-						return $entry['FN'];
-					}
-				}
-			}
-		}
-
-		$this->federatedContacts[$federatedCloudId] = '';
-		throw new \OutOfBoundsException('No contact found for federated cloud id');
-	}
+    /** @var IFactory */
+    protected $factory;
+    /** @var IManager */
+    protected $contactsManager;
+    /** @var IURLGenerator */
+    protected $url;
+    /** @var array */
+    protected $federatedContacts;
+    /** @var ICloudIdManager */
+    protected $cloudIdManager;
+
+    /**
+     * @param IFactory $factory
+     * @param IManager $contactsManager
+     * @param IURLGenerator $url
+     * @param ICloudIdManager $cloudIdManager
+     */
+    public function __construct(IFactory $factory, IManager $contactsManager, IURLGenerator $url, ICloudIdManager $cloudIdManager) {
+        $this->factory = $factory;
+        $this->contactsManager = $contactsManager;
+        $this->url = $url;
+        $this->cloudIdManager = $cloudIdManager;
+    }
+
+    /**
+     * @param INotification $notification
+     * @param string $languageCode The code of the language that should be used to prepare the notification
+     * @return INotification
+     * @throws \InvalidArgumentException
+     */
+    public function prepare(INotification $notification, $languageCode) {
+        if ($notification->getApp() !== 'files_sharing') {
+            // Not my app => throw
+            throw new \InvalidArgumentException();
+        }
+
+        // Read the language from the notification
+        $l = $this->factory->get('files_sharing', $languageCode);
+
+        switch ($notification->getSubject()) {
+            // Deal with known subjects
+            case 'remote_share':
+                $notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg')));
+
+                $params = $notification->getSubjectParameters();
+                if ($params[0] !== $params[1] && $params[1] !== null) {
+                    $notification->setParsedSubject(
+                        $l->t('You received "%3$s" as a remote share from %1$s (on behalf of %2$s)', $params)
+                    );
+                    $notification->setRichSubject(
+                        $l->t('You received {share} as a remote share from {user} (on behalf of {behalf})'),
+                        [
+                            'share' => [
+                                'type' => 'pending-federated-share',
+                                'id' => $notification->getObjectId(),
+                                'name' => $params[2],
+                            ],
+                            'user' => $this->createRemoteUser($params[0]),
+                            'behalf' => $this->createRemoteUser($params[1]),
+                        ]
+                    );
+                } else {
+                    $notification->setParsedSubject(
+                        $l->t('You received "%3$s" as a remote share from %1$s', $params)
+                    );
+                    $notification->setRichSubject(
+                        $l->t('You received {share} as a remote share from {user}'),
+                        [
+                            'share' => [
+                                'type' => 'pending-federated-share',
+                                'id' => $notification->getObjectId(),
+                                'name' => $params[2],
+                            ],
+                            'user' => $this->createRemoteUser($params[0]),
+                        ]
+                    );
+                }
+
+                // Deal with the actions for a known subject
+                foreach ($notification->getActions() as $action) {
+                    switch ($action->getLabel()) {
+                        case 'accept':
+                            $action->setParsedLabel(
+                                (string) $l->t('Accept')
+                            )
+                            ->setPrimary(true);
+                            break;
+
+                        case 'decline':
+                            $action->setParsedLabel(
+                                (string) $l->t('Decline')
+                            );
+                            break;
+                    }
+
+                    $notification->addParsedAction($action);
+                }
+                return $notification;
+
+            default:
+                // Unknown subject => Unknown notification => throw
+                throw new \InvalidArgumentException();
+        }
+    }
+
+    /**
+     * @param string $cloudId
+     * @return array
+     */
+    protected function createRemoteUser($cloudId) {
+        $displayName = $cloudId;
+        try {
+            $resolvedId = $this->cloudIdManager->resolveCloudId($cloudId);
+            $displayName = $this->getDisplayName($resolvedId);
+            $user = $resolvedId->getUser();
+            $server = $resolvedId->getRemote();
+        } catch (HintException $e) {
+            $user = $cloudId;
+            $server = '';
+        }
+
+        return [
+            'type' => 'user',
+            'id' => $user,
+            'name' => $displayName,
+            'server' => $server,
+        ];
+    }
+
+    /**
+     * Try to find the user in the contacts
+     *
+     * @param ICloudId $cloudId
+     * @return string
+     */
+    protected function getDisplayName(ICloudId $cloudId) {
+        $server = $cloudId->getRemote();
+        $user = $cloudId->getUser();
+        if (strpos($server, 'http://') === 0) {
+            $server = substr($server, strlen('http://'));
+        } else if (strpos($server, 'https://') === 0) {
+            $server = substr($server, strlen('https://'));
+        }
+
+        try {
+            return $this->getDisplayNameFromContact($cloudId->getId());
+        } catch (\OutOfBoundsException $e) {
+        }
+
+        try {
+            $this->getDisplayNameFromContact($user . '@http://' . $server);
+        } catch (\OutOfBoundsException $e) {
+        }
+
+        try {
+            $this->getDisplayNameFromContact($user . '@https://' . $server);
+        } catch (\OutOfBoundsException $e) {
+        }
+
+        return $cloudId->getId();
+    }
+
+    /**
+     * Try to find the user in the contacts
+     *
+     * @param string $federatedCloudId
+     * @return string
+     * @throws \OutOfBoundsException when there is no contact for the id
+     */
+    protected function getDisplayNameFromContact($federatedCloudId) {
+        if (isset($this->federatedContacts[$federatedCloudId])) {
+            if ($this->federatedContacts[$federatedCloudId] !== '') {
+                return $this->federatedContacts[$federatedCloudId];
+            } else {
+                throw new \OutOfBoundsException('No contact found for federated cloud id');
+            }
+        }
+
+        $addressBookEntries = $this->contactsManager->search($federatedCloudId, ['CLOUD']);
+        foreach ($addressBookEntries as $entry) {
+            if (isset($entry['CLOUD'])) {
+                foreach ($entry['CLOUD'] as $cloudID) {
+                    if ($cloudID === $federatedCloudId) {
+                        $this->federatedContacts[$federatedCloudId] = $entry['FN'];
+                        return $entry['FN'];
+                    }
+                }
+            }
+        }
+
+        $this->federatedContacts[$federatedCloudId] = '';
+        throw new \OutOfBoundsException('No contact found for federated cloud id');
+    }
 }

apps/federatedfilesharing/lib/TokenHandler.php

Indentation +25 added lines, -25 removed lines

@@ -33,30 +33,30 @@
  */
 class TokenHandler {
 
-	const TOKEN_LENGTH = 15;
-
-	/** @var ISecureRandom */
-	private $secureRandom;
-
-	/**
-	 * TokenHandler constructor.
-	 *
-	 * @param ISecureRandom $secureRandom
-	 */
-	public function __construct(ISecureRandom $secureRandom) {
-		$this->secureRandom = $secureRandom;
-	}
-
-	/**
-	 * generate to token used to authenticate federated shares
-	 *
-	 * @return string
-	 */
-	public function generateToken() {
-		$token = $this->secureRandom->generate(
-			self::TOKEN_LENGTH,
-			ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
-		return $token;
-	}
+    const TOKEN_LENGTH = 15;
+
+    /** @var ISecureRandom */
+    private $secureRandom;
+
+    /**
+     * TokenHandler constructor.
+     *
+     * @param ISecureRandom $secureRandom
+     */
+    public function __construct(ISecureRandom $secureRandom) {
+        $this->secureRandom = $secureRandom;
+    }
+
+    /**
+     * generate to token used to authenticate federated shares
+     *
+     * @return string
+     */
+    public function generateToken() {
+        $token = $this->secureRandom->generate(
+            self::TOKEN_LENGTH,
+            ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
+        return $token;
+    }
 
 }

apps/federation/templates/settings-admin.php

Indentation +4 added lines, -4 removed lines

@@ -28,10 +28,10 @@
 				<?php if((int)$trustedServer['status'] === TrustedServers::STATUS_OK) { ?>
 					<span class="status success"></span>
 				<?php
-				} elseif(
-					(int)$trustedServer['status'] === TrustedServers::STATUS_PENDING ||
-					(int)$trustedServer['status'] === TrustedServers::STATUS_ACCESS_REVOKED
-				) { ?>
+                } elseif(
+                    (int)$trustedServer['status'] === TrustedServers::STATUS_PENDING ||
+                    (int)$trustedServer['status'] === TrustedServers::STATUS_ACCESS_REVOKED
+                ) { ?>
 					<span class="status indeterminate"></span>
 				<?php } else {?>
 					<span class="status error"></span>

apps/federation/lib/Settings/Admin.php

Indentation +31 added lines, -31 removed lines

@@ -29,41 +29,41 @@
 
 class Admin implements ISettings {
 
-	/** @var TrustedServers */
-	private $trustedServers;
+    /** @var TrustedServers */
+    private $trustedServers;
 
-	public function __construct(TrustedServers $trustedServers) {
-		$this->trustedServers = $trustedServers;
-	}
+    public function __construct(TrustedServers $trustedServers) {
+        $this->trustedServers = $trustedServers;
+    }
 
-	/**
-	 * @return TemplateResponse
-	 */
-	public function getForm() {
-		$parameters = [
-			'trustedServers' => $this->trustedServers->getServers(),
-			'autoAddServers' => $this->trustedServers->getAutoAddServers(),
-		];
+    /**
+     * @return TemplateResponse
+     */
+    public function getForm() {
+        $parameters = [
+            'trustedServers' => $this->trustedServers->getServers(),
+            'autoAddServers' => $this->trustedServers->getAutoAddServers(),
+        ];
 
-		return new TemplateResponse('federation', 'settings-admin', $parameters, '');
-	}
+        return new TemplateResponse('federation', 'settings-admin', $parameters, '');
+    }
 
-	/**
-	 * @return string the section ID, e.g. 'sharing'
-	 */
-	public function getSection() {
-		return 'sharing';
-	}
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     */
+    public function getSection() {
+        return 'sharing';
+    }
 
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the admin section. The forms are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 */
-	public function getPriority() {
-		return 30;
-	}
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     */
+    public function getPriority() {
+        return 30;
+    }
 
 }

apps/federation/lib/Hooks.php

Indentation +20 added lines, -20 removed lines

@@ -27,25 +27,25 @@
 
 class Hooks {
 
-	/** @var TrustedServers */
-	private $trustedServers;
-
-	public function __construct(TrustedServers $trustedServers) {
-		$this->trustedServers = $trustedServers;
-	}
-
-	/**
-	 * add servers to the list of trusted servers once a federated share was established
-	 *
-	 * @param array $params
-	 */
-	public function addServerHook($params) {
-		if (
-			$this->trustedServers->getAutoAddServers() === true &&
-			$this->trustedServers->isTrustedServer($params['server']) === false
-		) {
-			$this->trustedServers->addServer($params['server']);
-		}
-	}
+    /** @var TrustedServers */
+    private $trustedServers;
+
+    public function __construct(TrustedServers $trustedServers) {
+        $this->trustedServers = $trustedServers;
+    }
+
+    /**
+     * add servers to the list of trusted servers once a federated share was established
+     *
+     * @param array $params
+     */
+    public function addServerHook($params) {
+        if (
+            $this->trustedServers->getAutoAddServers() === true &&
+            $this->trustedServers->isTrustedServer($params['server']) === false
+        ) {
+            $this->trustedServers->addServer($params['server']);
+        }
+    }
 
 }

apps/dav/lib/DAV/PublicAuth.php

Indentation +58 added lines, -58 removed lines

@@ -26,67 +26,67 @@
 
 class PublicAuth implements BackendInterface {
 
-	/** @var string[] */
-	private $publicURLs;
+    /** @var string[] */
+    private $publicURLs;
 
-	public function __construct() {
-		$this->publicURLs = [
-			'public-calendars',
-			'principals/system/public'
-		];
-	}
+    public function __construct() {
+        $this->publicURLs = [
+            'public-calendars',
+            'principals/system/public'
+        ];
+    }
 
-	/**
-	 * When this method is called, the backend must check if authentication was
-	 * successful.
-	 *
-	 * The returned value must be one of the following
-	 *
-	 * [true, "principals/username"]
-	 * [false, "reason for failure"]
-	 *
-	 * If authentication was successful, it's expected that the authentication
-	 * backend returns a so-called principal url.
-	 *
-	 * Examples of a principal url:
-	 *
-	 * principals/admin
-	 * principals/user1
-	 * principals/users/joe
-	 * principals/uid/123457
-	 *
-	 * If you don't use WebDAV ACL (RFC3744) we recommend that you simply
-	 * return a string such as:
-	 *
-	 * principals/users/[username]
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 * @return array
-	 */
-	function check(RequestInterface $request, ResponseInterface $response) {
+    /**
+     * When this method is called, the backend must check if authentication was
+     * successful.
+     *
+     * The returned value must be one of the following
+     *
+     * [true, "principals/username"]
+     * [false, "reason for failure"]
+     *
+     * If authentication was successful, it's expected that the authentication
+     * backend returns a so-called principal url.
+     *
+     * Examples of a principal url:
+     *
+     * principals/admin
+     * principals/user1
+     * principals/users/joe
+     * principals/uid/123457
+     *
+     * If you don't use WebDAV ACL (RFC3744) we recommend that you simply
+     * return a string such as:
+     *
+     * principals/users/[username]
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return array
+     */
+    function check(RequestInterface $request, ResponseInterface $response) {
 
-		if ($this->isRequestPublic($request)) {
-			return [true, "principals/system/public"];
-		}
-		return [false, "No public access to this resource."];
-	}
+        if ($this->isRequestPublic($request)) {
+            return [true, "principals/system/public"];
+        }
+        return [false, "No public access to this resource."];
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function challenge(RequestInterface $request, ResponseInterface $response) {
-	}
+    /**
+     * @inheritdoc
+     */
+    function challenge(RequestInterface $request, ResponseInterface $response) {
+    }
 
-	/**
-	 * @param RequestInterface $request
-	 * @return bool
-	 */
-	private function isRequestPublic(RequestInterface $request) {
-		$url = $request->getPath();
-		$matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) {
-			return strpos($url, $publicUrl, 0) === 0;
-		});
-		return !empty($matchingUrls);
-	}
+    /**
+     * @param RequestInterface $request
+     * @return bool
+     */
+    private function isRequestPublic(RequestInterface $request) {
+        $url = $request->getPath();
+        $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) {
+            return strpos($url, $publicUrl, 0) === 0;
+        });
+        return !empty($matchingUrls);
+    }
 }

apps/dav/lib/DAV/Sharing/Xml/Invite.php

Indentation +126 added lines, -126 removed lines

@@ -41,130 +41,130 @@
  */
 class Invite implements XmlSerializable {
 
-	/**
-	 * The list of users a calendar has been shared to.
-	 *
-	 * @var array
-	 */
-	protected $users;
-
-	/**
-	 * The organizer contains information about the person who shared the
-	 * object.
-	 *
-	 * @var array|null
-	 */
-	protected $organizer;
-
-	/**
-	 * Creates the property.
-	 *
-	 * Users is an array. Each element of the array has the following
-	 * properties:
-	 *
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first and lastname for a user.
-	 *   * status - One of the SharingPlugin::STATUS_* constants.
-	 *   * readOnly - true or false
-	 *   * summary - Optional, description of the share
-	 *
-	 * The organizer key is optional to specify. It's only useful when a
-	 * 'sharee' requests the sharing information.
-	 *
-	 * The organizer may have the following properties:
-	 *   * href - Often a mailto: address.
-	 *   * commonName - Optional human-readable name.
-	 *   * firstName - Optional first name.
-	 *   * lastName - Optional last name.
-	 *
-	 * If you wonder why these two structures are so different, I guess a
-	 * valid answer is that the current spec is still a draft.
-	 *
-	 * @param array $users
-	 */
-	function __construct(array $users, array $organizer = null) {
-
-		$this->users = $users;
-		$this->organizer = $organizer;
-
-	}
-
-	/**
-	 * Returns the list of users, as it was passed to the constructor.
-	 *
-	 * @return array
-	 */
-	function getValue() {
-
-		return $this->users;
-
-	}
-
-	/**
-	 * The xmlSerialize metod is called during xml writing.
-	 *
-	 * Use the $writer argument to write its own xml serialization.
-	 *
-	 * An important note: do _not_ create a parent element. Any element
-	 * implementing XmlSerializble should only ever write what's considered
-	 * its 'inner xml'.
-	 *
-	 * The parent of the current element is responsible for writing a
-	 * containing element.
-	 *
-	 * This allows serializers to be re-used for different element names.
-	 *
-	 * If you are opening new elements, you must also close them again.
-	 *
-	 * @param Writer $writer
-	 * @return void
-	 */
-	function xmlSerialize(Writer $writer) {
-
-		$cs = '{' . Plugin::NS_OWNCLOUD . '}';
-
-		if (!is_null($this->organizer)) {
-
-			$writer->startElement($cs . 'organizer');
-			$writer->writeElement('{DAV:}href', $this->organizer['href']);
-
-			if (isset($this->organizer['commonName']) && $this->organizer['commonName']) {
-				$writer->writeElement($cs . 'common-name', $this->organizer['commonName']);
-			}
-			if (isset($this->organizer['firstName']) && $this->organizer['firstName']) {
-				$writer->writeElement($cs . 'first-name', $this->organizer['firstName']);
-			}
-			if (isset($this->organizer['lastName']) && $this->organizer['lastName']) {
-				$writer->writeElement($cs . 'last-name', $this->organizer['lastName']);
-			}
-			$writer->endElement(); // organizer
-
-		}
-
-		foreach ($this->users as $user) {
-
-			$writer->startElement($cs . 'user');
-			$writer->writeElement('{DAV:}href', $user['href']);
-			if (isset($user['commonName']) && $user['commonName']) {
-				$writer->writeElement($cs . 'common-name', $user['commonName']);
-			}
-			$writer->writeElement($cs . 'invite-accepted');
-
-			$writer->startElement($cs . 'access');
-			if ($user['readOnly']) {
-				$writer->writeElement($cs . 'read');
-			} else {
-				$writer->writeElement($cs . 'read-write');
-			}
-			$writer->endElement(); // access
-
-			if (isset($user['summary']) && $user['summary']) {
-				$writer->writeElement($cs . 'summary', $user['summary']);
-			}
-
-			$writer->endElement(); //user
-
-		}
-
-	}
+    /**
+     * The list of users a calendar has been shared to.
+     *
+     * @var array
+     */
+    protected $users;
+
+    /**
+     * The organizer contains information about the person who shared the
+     * object.
+     *
+     * @var array|null
+     */
+    protected $organizer;
+
+    /**
+     * Creates the property.
+     *
+     * Users is an array. Each element of the array has the following
+     * properties:
+     *
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first and lastname for a user.
+     *   * status - One of the SharingPlugin::STATUS_* constants.
+     *   * readOnly - true or false
+     *   * summary - Optional, description of the share
+     *
+     * The organizer key is optional to specify. It's only useful when a
+     * 'sharee' requests the sharing information.
+     *
+     * The organizer may have the following properties:
+     *   * href - Often a mailto: address.
+     *   * commonName - Optional human-readable name.
+     *   * firstName - Optional first name.
+     *   * lastName - Optional last name.
+     *
+     * If you wonder why these two structures are so different, I guess a
+     * valid answer is that the current spec is still a draft.
+     *
+     * @param array $users
+     */
+    function __construct(array $users, array $organizer = null) {
+
+        $this->users = $users;
+        $this->organizer = $organizer;
+
+    }
+
+    /**
+     * Returns the list of users, as it was passed to the constructor.
+     *
+     * @return array
+     */
+    function getValue() {
+
+        return $this->users;
+
+    }
+
+    /**
+     * The xmlSerialize metod is called during xml writing.
+     *
+     * Use the $writer argument to write its own xml serialization.
+     *
+     * An important note: do _not_ create a parent element. Any element
+     * implementing XmlSerializble should only ever write what's considered
+     * its 'inner xml'.
+     *
+     * The parent of the current element is responsible for writing a
+     * containing element.
+     *
+     * This allows serializers to be re-used for different element names.
+     *
+     * If you are opening new elements, you must also close them again.
+     *
+     * @param Writer $writer
+     * @return void
+     */
+    function xmlSerialize(Writer $writer) {
+
+        $cs = '{' . Plugin::NS_OWNCLOUD . '}';
+
+        if (!is_null($this->organizer)) {
+
+            $writer->startElement($cs . 'organizer');
+            $writer->writeElement('{DAV:}href', $this->organizer['href']);
+
+            if (isset($this->organizer['commonName']) && $this->organizer['commonName']) {
+                $writer->writeElement($cs . 'common-name', $this->organizer['commonName']);
+            }
+            if (isset($this->organizer['firstName']) && $this->organizer['firstName']) {
+                $writer->writeElement($cs . 'first-name', $this->organizer['firstName']);
+            }
+            if (isset($this->organizer['lastName']) && $this->organizer['lastName']) {
+                $writer->writeElement($cs . 'last-name', $this->organizer['lastName']);
+            }
+            $writer->endElement(); // organizer
+
+        }
+
+        foreach ($this->users as $user) {
+
+            $writer->startElement($cs . 'user');
+            $writer->writeElement('{DAV:}href', $user['href']);
+            if (isset($user['commonName']) && $user['commonName']) {
+                $writer->writeElement($cs . 'common-name', $user['commonName']);
+            }
+            $writer->writeElement($cs . 'invite-accepted');
+
+            $writer->startElement($cs . 'access');
+            if ($user['readOnly']) {
+                $writer->writeElement($cs . 'read');
+            } else {
+                $writer->writeElement($cs . 'read-write');
+            }
+            $writer->endElement(); // access
+
+            if (isset($user['summary']) && $user['summary']) {
+                $writer->writeElement($cs . 'summary', $user['summary']);
+            }
+
+            $writer->endElement(); //user
+
+        }
+
+    }
 }

apps/dav/lib/DAV/Sharing/IShareable.php

Indentation +40 added lines, -40 removed lines

@@ -28,48 +28,48 @@
  */
 interface IShareable extends INode {
 
-	/**
-	 * Updates the list of shares.
-	 *
-	 * The first array is a list of people that are to be added to the
-	 * resource.
-	 *
-	 * Every element in the add array has the following properties:
-	 *   * href - A url. Usually a mailto: address
-	 *   * commonName - Usually a first and last name, or false
-	 *   * summary - A description of the share, can also be false
-	 *   * readOnly - A boolean value
-	 *
-	 * Every element in the remove array is just the address string.
-	 *
-	 * @param array $add
-	 * @param array $remove
-	 * @return void
-	 */
-	function updateShares(array $add, array $remove);
+    /**
+     * Updates the list of shares.
+     *
+     * The first array is a list of people that are to be added to the
+     * resource.
+     *
+     * Every element in the add array has the following properties:
+     *   * href - A url. Usually a mailto: address
+     *   * commonName - Usually a first and last name, or false
+     *   * summary - A description of the share, can also be false
+     *   * readOnly - A boolean value
+     *
+     * Every element in the remove array is just the address string.
+     *
+     * @param array $add
+     * @param array $remove
+     * @return void
+     */
+    function updateShares(array $add, array $remove);
 
-	/**
-	 * Returns the list of people whom this resource is shared with.
-	 *
-	 * Every element in this array should have the following properties:
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first + last name
-	 *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
-	 *   * readOnly - boolean
-	 *   * summary - Optional, a description for the share
-	 *
-	 * @return array
-	 */
-	function getShares();
+    /**
+     * Returns the list of people whom this resource is shared with.
+     *
+     * Every element in this array should have the following properties:
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first + last name
+     *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
+     *   * readOnly - boolean
+     *   * summary - Optional, a description for the share
+     *
+     * @return array
+     */
+    function getShares();
 
-	/**
-	 * @return int
-	 */
-	public function getResourceId();
+    /**
+     * @return int
+     */
+    public function getResourceId();
 
-	/**
-	 * @return string
-	 */
-	public function getOwner();
+    /**
+     * @return string
+     */
+    public function getOwner();
 
 }
\ No newline at end of file