nextcloud / server

apps/sharebymail/lib/ShareByMailProvider.php

Doc Comments +11 added lines, -4 removed lines

@@ -193,10 +193,10 @@ 
 	 * publish activity if a file/folder was shared by mail
 	 *
 	 * @param $subject
-	 * @param $parameters
-	 * @param $affectedUser
+	 * @param string[] $parameters
+	 * @param string $affectedUser
 	 * @param $fileId
-	 * @param $filePath
+	 * @param string $filePath
 	 */
 	protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
 		$event = $this->activityManager->generateEvent();
@@ -248,6 +248,12 @@ 
 
 	}
 
+	/**
+	 * @param string $link
+	 * @param string $owner
+	 * @param string $initiator
+	 * @param string $shareWith
+	 */
 	protected function sendMailNotification($filename, $link, $owner, $initiator, $shareWith) {
 		$ownerUser = $this->userManager->get($owner);
 		$initiatorUser = $this->userManager->get($initiator);
@@ -296,6 +302,7 @@ 
 	 * @param string $filename
 	 * @param string $initiator
 	 * @param string $shareWith
+	 * @param string $password
 	 */
 	protected function sendPassword($filename, $initiator, $shareWith, $password) {
 
@@ -769,7 +776,7 @@ 
 	/**
 	 * get database row of a give share
 	 *
-	 * @param $id
+	 * @param integer $id
 	 * @return array
 	 * @throws ShareNotFound
 	 */

Unused Use Statements -1 removed lines

@@ -41,7 +41,6 @@
 use OCP\Share\Exceptions\ShareNotFound;
 use OCP\Share\IShare;
 use OCP\Share\IShareProvider;
-use OCP\Template;
 
 /**
  * Class ShareByMail

Indentation +770 added lines, -770 removed lines

@@ -50,788 +50,788 @@
  */
 class ShareByMailProvider implements IShareProvider {
 
-	/** @var  IDBConnection */
-	private $dbConnection;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var ISecureRandom */
-	private $secureRandom;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var IMailer */
-	private $mailer;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var IManager  */
-	private $activityManager;
-
-	/** @var SettingsManager */
-	private $settingsManager;
-
-	/**
-	 * Return the identifier of this provider.
-	 *
-	 * @return string Containing only [a-zA-Z0-9]
-	 */
-	public function identifier() {
-		return 'ocMailShare';
-	}
-
-	/**
-	 * DefaultShareProvider constructor.
-	 *
-	 * @param IDBConnection $connection
-	 * @param ISecureRandom $secureRandom
-	 * @param IUserManager $userManager
-	 * @param IRootFolder $rootFolder
-	 * @param IL10N $l
-	 * @param ILogger $logger
-	 * @param IMailer $mailer
-	 * @param IURLGenerator $urlGenerator
-	 * @param IManager $activityManager
-	 * @param SettingsManager $settingsManager
-	 */
-	public function __construct(
-		IDBConnection $connection,
-		ISecureRandom $secureRandom,
-		IUserManager $userManager,
-		IRootFolder $rootFolder,
-		IL10N $l,
-		ILogger $logger,
-		IMailer $mailer,
-		IURLGenerator $urlGenerator,
-		IManager $activityManager,
-		SettingsManager $settingsManager
-	) {
-		$this->dbConnection = $connection;
-		$this->secureRandom = $secureRandom;
-		$this->userManager = $userManager;
-		$this->rootFolder = $rootFolder;
-		$this->l = $l;
-		$this->logger = $logger;
-		$this->mailer = $mailer;
-		$this->urlGenerator = $urlGenerator;
-		$this->activityManager = $activityManager;
-		$this->settingsManager = $settingsManager;
-	}
-
-	/**
-	 * Share a path
-	 *
-	 * @param IShare $share
-	 * @return IShare The share object
-	 * @throws ShareNotFound
-	 * @throws \Exception
-	 */
-	public function create(IShare $share) {
-
-		$shareWith = $share->getSharedWith();
-		/*
+    /** @var  IDBConnection */
+    private $dbConnection;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var ISecureRandom */
+    private $secureRandom;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var IMailer */
+    private $mailer;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var IManager  */
+    private $activityManager;
+
+    /** @var SettingsManager */
+    private $settingsManager;
+
+    /**
+     * Return the identifier of this provider.
+     *
+     * @return string Containing only [a-zA-Z0-9]
+     */
+    public function identifier() {
+        return 'ocMailShare';
+    }
+
+    /**
+     * DefaultShareProvider constructor.
+     *
+     * @param IDBConnection $connection
+     * @param ISecureRandom $secureRandom
+     * @param IUserManager $userManager
+     * @param IRootFolder $rootFolder
+     * @param IL10N $l
+     * @param ILogger $logger
+     * @param IMailer $mailer
+     * @param IURLGenerator $urlGenerator
+     * @param IManager $activityManager
+     * @param SettingsManager $settingsManager
+     */
+    public function __construct(
+        IDBConnection $connection,
+        ISecureRandom $secureRandom,
+        IUserManager $userManager,
+        IRootFolder $rootFolder,
+        IL10N $l,
+        ILogger $logger,
+        IMailer $mailer,
+        IURLGenerator $urlGenerator,
+        IManager $activityManager,
+        SettingsManager $settingsManager
+    ) {
+        $this->dbConnection = $connection;
+        $this->secureRandom = $secureRandom;
+        $this->userManager = $userManager;
+        $this->rootFolder = $rootFolder;
+        $this->l = $l;
+        $this->logger = $logger;
+        $this->mailer = $mailer;
+        $this->urlGenerator = $urlGenerator;
+        $this->activityManager = $activityManager;
+        $this->settingsManager = $settingsManager;
+    }
+
+    /**
+     * Share a path
+     *
+     * @param IShare $share
+     * @return IShare The share object
+     * @throws ShareNotFound
+     * @throws \Exception
+     */
+    public function create(IShare $share) {
+
+        $shareWith = $share->getSharedWith();
+        /*
 		 * Check if file is not already shared with the remote user
 		 */
-		$alreadyShared = $this->getSharedWith($shareWith, \OCP\Share::SHARE_TYPE_EMAIL, $share->getNode(), 1, 0);
-		if (!empty($alreadyShared)) {
-			$message = 'Sharing %s failed, this item is already shared with %s';
-			$message_t = $this->l->t('Sharing %s failed, this item is already shared with %s', array($share->getNode()->getName(), $shareWith));
-			$this->logger->debug(sprintf($message, $share->getNode()->getName(), $shareWith), ['app' => 'Federated File Sharing']);
-			throw new \Exception($message_t);
-		}
-
-		$shareId = $this->createMailShare($share);
-		$this->createActivity($share);
-		$data = $this->getRawShare($shareId);
-		return $this->createShareObject($data);
-
-	}
-
-	/**
-	 * create activity if a file/folder was shared by mail
-	 *
-	 * @param IShare $share
-	 */
-	protected function createActivity(IShare $share) {
-
-		$userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
-
-		$this->publishActivity(
-			Activity::SUBJECT_SHARED_EMAIL_SELF,
-			[$userFolder->getRelativePath($share->getNode()->getPath()), $share->getSharedWith()],
-			$share->getSharedBy(),
-			$share->getNode()->getId(),
-			$userFolder->getRelativePath($share->getNode()->getPath())
-		);
-
-		if ($share->getShareOwner() !== $share->getSharedBy()) {
-			$ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-			$fileId = $share->getNode()->getId();
-			$nodes = $ownerFolder->getById($fileId);
-			$ownerPath = $nodes[0]->getPath();
-			$this->publishActivity(
-				Activity::SUBJECT_SHARED_EMAIL_BY,
-				[$ownerFolder->getRelativePath($ownerPath), $share->getSharedWith(), $share->getSharedBy()],
-				$share->getShareOwner(),
-				$fileId,
-				$ownerFolder->getRelativePath($ownerPath)
-			);
-		}
-
-	}
-
-	/**
-	 * publish activity if a file/folder was shared by mail
-	 *
-	 * @param $subject
-	 * @param $parameters
-	 * @param $affectedUser
-	 * @param $fileId
-	 * @param $filePath
-	 */
-	protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
-		$event = $this->activityManager->generateEvent();
-		$event->setApp('sharebymail')
-			->setType('shared')
-			->setSubject($subject, $parameters)
-			->setAffectedUser($affectedUser)
-			->setObject('files', $fileId, $filePath);
-		$this->activityManager->publish($event);
-
-	}
-
-	/**
-	 * @param IShare $share
-	 * @return int
-	 * @throws \Exception
-	 */
-	protected function createMailShare(IShare $share) {
-		$share->setToken($this->generateToken());
-		$shareId = $this->addShareToDB(
-			$share->getNodeId(),
-			$share->getNodeType(),
-			$share->getSharedWith(),
-			$share->getSharedBy(),
-			$share->getShareOwner(),
-			$share->getPermissions(),
-			$share->getToken()
-		);
-
-		try {
-			$link = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare',
-				['token' => $share->getToken()]);
-			$this->sendMailNotification($share->getNode()->getName(),
-				$link,
-				$share->getShareOwner(),
-				$share->getSharedBy(), $share->getSharedWith());
-		} catch (HintException $hintException) {
-			$this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
-			$this->removeShareFromTable($shareId);
-			throw $hintException;
-		} catch (\Exception $e) {
-			$this->logger->error('Failed to send share by mail: ' . $e->getMessage());
-			$this->removeShareFromTable($shareId);
-			throw new HintException('Failed to send share by mail',
-				$this->l->t('Failed to send share by E-mail'));
-		}
-
-		return $shareId;
-
-	}
-
-	protected function sendMailNotification($filename, $link, $owner, $initiator, $shareWith) {
-		$ownerUser = $this->userManager->get($owner);
-		$initiatorUser = $this->userManager->get($initiator);
-		$ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
-		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
-		if ($owner === $initiator) {
-			$subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
-		} else {
-			$subject = (string)$this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
-		}
-
-		$message = $this->mailer->createMessage();
-
-		$emailTemplate = $this->mailer->createEMailTemplate();
-
-		$emailTemplate->addHeader();
-		$emailTemplate->addHeading($this->l->t('%s shared »%s« with you', [$ownerDisplayName, $filename]), false);
-
-		if ($owner === $initiator) {
-			$text = $this->l->t('%s shared »%s« with you.', [$ownerDisplayName, $filename]);
-		} else {
-			$text= $this->l->t('%s shared »%s« with you on behalf of %s.', [$ownerDisplayName, $filename, $initiator]);
-		}
-
-		$emailTemplate->addBodyText(
-			$text . ' ' . $this->l->t('Click the button below to open it.'),
-			$text
-		);
-
-		$emailTemplate->addBodyButton(
-			$this->l->t('Open »%s«', [$filename]),
-			$link
-		);
-		$emailTemplate->addFooter();
-
-		$message->setTo([$shareWith]);
-		$message->setSubject($subject);
-		$message->setBody($emailTemplate->renderText(), 'text/plain');
-		$message->setHtmlBody($emailTemplate->renderHTML());
-		$this->mailer->send($message);
-
-	}
-
-	/**
-	 * send password to recipient of a mail share
-	 *
-	 * @param string $filename
-	 * @param string $initiator
-	 * @param string $shareWith
-	 */
-	protected function sendPassword($filename, $initiator, $shareWith, $password) {
-
-		if ($this->settingsManager->sendPasswordByMail() === false) {
-			return;
-		}
-
-		$initiatorUser = $this->userManager->get($initiator);
-		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
-		$subject = (string)$this->l->t('Password to access »%s« shared to you by %s', [$filename, $initiatorDisplayName]);
-
-		$message = $this->mailer->createMessage();
-
-		$emailTemplate = $this->mailer->createEMailTemplate();
-
-		$emailTemplate->addHeader();
-		$emailTemplate->addHeading($this->l->t('Password to access »%s«', [$filename]));
-
-		$emailTemplate->addBodyText($this->l->t(
-			'%s shared »%s« with you. You should have already received a separate mail with a link to access it.',
-				[$initiatorDisplayName, $filename]
-		));
-		$emailTemplate->addBodyText($this->l->t('It is protected with the following password: %s', [$password]));
-
-		$emailTemplate->addFooter();
-
-		$message->setTo([$shareWith]);
-		$message->setSubject($subject);
-		$message->setBody($emailTemplate->renderText(), 'text/plain');
-		$message->setHtmlBody($emailTemplate->renderHTML());
-		$this->mailer->send($message);
-
-	}
-
-
-	/**
-	 * generate share token
-	 *
-	 * @return string
-	 */
-	protected function generateToken() {
-		$token = $this->secureRandom->generate(
-			15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
-		return $token;
-	}
-
-	/**
-	 * Get all children of this share
-	 *
-	 * @param IShare $parent
-	 * @return IShare[]
-	 */
-	public function getChildren(IShare $parent) {
-		$children = [];
-
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId())))
-			->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->orderBy('id');
-
-		$cursor = $qb->execute();
-		while($data = $cursor->fetch()) {
-			$children[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $children;
-	}
-
-	/**
-	 * add share to the database and return the ID
-	 *
-	 * @param int $itemSource
-	 * @param string $itemType
-	 * @param string $shareWith
-	 * @param string $sharedBy
-	 * @param string $uidOwner
-	 * @param int $permissions
-	 * @param string $token
-	 * @return int
-	 */
-	protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->insert('share')
-			->setValue('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
-			->setValue('item_type', $qb->createNamedParameter($itemType))
-			->setValue('item_source', $qb->createNamedParameter($itemSource))
-			->setValue('file_source', $qb->createNamedParameter($itemSource))
-			->setValue('share_with', $qb->createNamedParameter($shareWith))
-			->setValue('uid_owner', $qb->createNamedParameter($uidOwner))
-			->setValue('uid_initiator', $qb->createNamedParameter($sharedBy))
-			->setValue('permissions', $qb->createNamedParameter($permissions))
-			->setValue('token', $qb->createNamedParameter($token))
-			->setValue('stime', $qb->createNamedParameter(time()));
-
-		/*
+        $alreadyShared = $this->getSharedWith($shareWith, \OCP\Share::SHARE_TYPE_EMAIL, $share->getNode(), 1, 0);
+        if (!empty($alreadyShared)) {
+            $message = 'Sharing %s failed, this item is already shared with %s';
+            $message_t = $this->l->t('Sharing %s failed, this item is already shared with %s', array($share->getNode()->getName(), $shareWith));
+            $this->logger->debug(sprintf($message, $share->getNode()->getName(), $shareWith), ['app' => 'Federated File Sharing']);
+            throw new \Exception($message_t);
+        }
+
+        $shareId = $this->createMailShare($share);
+        $this->createActivity($share);
+        $data = $this->getRawShare($shareId);
+        return $this->createShareObject($data);
+
+    }
+
+    /**
+     * create activity if a file/folder was shared by mail
+     *
+     * @param IShare $share
+     */
+    protected function createActivity(IShare $share) {
+
+        $userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
+
+        $this->publishActivity(
+            Activity::SUBJECT_SHARED_EMAIL_SELF,
+            [$userFolder->getRelativePath($share->getNode()->getPath()), $share->getSharedWith()],
+            $share->getSharedBy(),
+            $share->getNode()->getId(),
+            $userFolder->getRelativePath($share->getNode()->getPath())
+        );
+
+        if ($share->getShareOwner() !== $share->getSharedBy()) {
+            $ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
+            $fileId = $share->getNode()->getId();
+            $nodes = $ownerFolder->getById($fileId);
+            $ownerPath = $nodes[0]->getPath();
+            $this->publishActivity(
+                Activity::SUBJECT_SHARED_EMAIL_BY,
+                [$ownerFolder->getRelativePath($ownerPath), $share->getSharedWith(), $share->getSharedBy()],
+                $share->getShareOwner(),
+                $fileId,
+                $ownerFolder->getRelativePath($ownerPath)
+            );
+        }
+
+    }
+
+    /**
+     * publish activity if a file/folder was shared by mail
+     *
+     * @param $subject
+     * @param $parameters
+     * @param $affectedUser
+     * @param $fileId
+     * @param $filePath
+     */
+    protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
+        $event = $this->activityManager->generateEvent();
+        $event->setApp('sharebymail')
+            ->setType('shared')
+            ->setSubject($subject, $parameters)
+            ->setAffectedUser($affectedUser)
+            ->setObject('files', $fileId, $filePath);
+        $this->activityManager->publish($event);
+
+    }
+
+    /**
+     * @param IShare $share
+     * @return int
+     * @throws \Exception
+     */
+    protected function createMailShare(IShare $share) {
+        $share->setToken($this->generateToken());
+        $shareId = $this->addShareToDB(
+            $share->getNodeId(),
+            $share->getNodeType(),
+            $share->getSharedWith(),
+            $share->getSharedBy(),
+            $share->getShareOwner(),
+            $share->getPermissions(),
+            $share->getToken()
+        );
+
+        try {
+            $link = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare',
+                ['token' => $share->getToken()]);
+            $this->sendMailNotification($share->getNode()->getName(),
+                $link,
+                $share->getShareOwner(),
+                $share->getSharedBy(), $share->getSharedWith());
+        } catch (HintException $hintException) {
+            $this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
+            $this->removeShareFromTable($shareId);
+            throw $hintException;
+        } catch (\Exception $e) {
+            $this->logger->error('Failed to send share by mail: ' . $e->getMessage());
+            $this->removeShareFromTable($shareId);
+            throw new HintException('Failed to send share by mail',
+                $this->l->t('Failed to send share by E-mail'));
+        }
+
+        return $shareId;
+
+    }
+
+    protected function sendMailNotification($filename, $link, $owner, $initiator, $shareWith) {
+        $ownerUser = $this->userManager->get($owner);
+        $initiatorUser = $this->userManager->get($initiator);
+        $ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
+        $initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+        if ($owner === $initiator) {
+            $subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
+        } else {
+            $subject = (string)$this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
+        }
+
+        $message = $this->mailer->createMessage();
+
+        $emailTemplate = $this->mailer->createEMailTemplate();
+
+        $emailTemplate->addHeader();
+        $emailTemplate->addHeading($this->l->t('%s shared »%s« with you', [$ownerDisplayName, $filename]), false);
+
+        if ($owner === $initiator) {
+            $text = $this->l->t('%s shared »%s« with you.', [$ownerDisplayName, $filename]);
+        } else {
+            $text= $this->l->t('%s shared »%s« with you on behalf of %s.', [$ownerDisplayName, $filename, $initiator]);
+        }
+
+        $emailTemplate->addBodyText(
+            $text . ' ' . $this->l->t('Click the button below to open it.'),
+            $text
+        );
+
+        $emailTemplate->addBodyButton(
+            $this->l->t('Open »%s«', [$filename]),
+            $link
+        );
+        $emailTemplate->addFooter();
+
+        $message->setTo([$shareWith]);
+        $message->setSubject($subject);
+        $message->setBody($emailTemplate->renderText(), 'text/plain');
+        $message->setHtmlBody($emailTemplate->renderHTML());
+        $this->mailer->send($message);
+
+    }
+
+    /**
+     * send password to recipient of a mail share
+     *
+     * @param string $filename
+     * @param string $initiator
+     * @param string $shareWith
+     */
+    protected function sendPassword($filename, $initiator, $shareWith, $password) {
+
+        if ($this->settingsManager->sendPasswordByMail() === false) {
+            return;
+        }
+
+        $initiatorUser = $this->userManager->get($initiator);
+        $initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+        $subject = (string)$this->l->t('Password to access »%s« shared to you by %s', [$filename, $initiatorDisplayName]);
+
+        $message = $this->mailer->createMessage();
+
+        $emailTemplate = $this->mailer->createEMailTemplate();
+
+        $emailTemplate->addHeader();
+        $emailTemplate->addHeading($this->l->t('Password to access »%s«', [$filename]));
+
+        $emailTemplate->addBodyText($this->l->t(
+            '%s shared »%s« with you. You should have already received a separate mail with a link to access it.',
+                [$initiatorDisplayName, $filename]
+        ));
+        $emailTemplate->addBodyText($this->l->t('It is protected with the following password: %s', [$password]));
+
+        $emailTemplate->addFooter();
+
+        $message->setTo([$shareWith]);
+        $message->setSubject($subject);
+        $message->setBody($emailTemplate->renderText(), 'text/plain');
+        $message->setHtmlBody($emailTemplate->renderHTML());
+        $this->mailer->send($message);
+
+    }
+
+
+    /**
+     * generate share token
+     *
+     * @return string
+     */
+    protected function generateToken() {
+        $token = $this->secureRandom->generate(
+            15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
+        return $token;
+    }
+
+    /**
+     * Get all children of this share
+     *
+     * @param IShare $parent
+     * @return IShare[]
+     */
+    public function getChildren(IShare $parent) {
+        $children = [];
+
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId())))
+            ->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->orderBy('id');
+
+        $cursor = $qb->execute();
+        while($data = $cursor->fetch()) {
+            $children[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $children;
+    }
+
+    /**
+     * add share to the database and return the ID
+     *
+     * @param int $itemSource
+     * @param string $itemType
+     * @param string $shareWith
+     * @param string $sharedBy
+     * @param string $uidOwner
+     * @param int $permissions
+     * @param string $token
+     * @return int
+     */
+    protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->insert('share')
+            ->setValue('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
+            ->setValue('item_type', $qb->createNamedParameter($itemType))
+            ->setValue('item_source', $qb->createNamedParameter($itemSource))
+            ->setValue('file_source', $qb->createNamedParameter($itemSource))
+            ->setValue('share_with', $qb->createNamedParameter($shareWith))
+            ->setValue('uid_owner', $qb->createNamedParameter($uidOwner))
+            ->setValue('uid_initiator', $qb->createNamedParameter($sharedBy))
+            ->setValue('permissions', $qb->createNamedParameter($permissions))
+            ->setValue('token', $qb->createNamedParameter($token))
+            ->setValue('stime', $qb->createNamedParameter(time()));
+
+        /*
 		 * Added to fix https://github.com/owncloud/core/issues/22215
 		 * Can be removed once we get rid of ajax/share.php
 		 */
-		$qb->setValue('file_target', $qb->createNamedParameter(''));
+        $qb->setValue('file_target', $qb->createNamedParameter(''));
 
-		$qb->execute();
-		$id = $qb->getLastInsertId();
+        $qb->execute();
+        $id = $qb->getLastInsertId();
 
-		return (int)$id;
-	}
+        return (int)$id;
+    }
 
-	/**
-	 * Update a share
-	 *
-	 * @param IShare $share
-	 * @param string|null $plainTextPassword
-	 * @return IShare The share object
-	 */
-	public function update(IShare $share, $plainTextPassword = null) {
+    /**
+     * Update a share
+     *
+     * @param IShare $share
+     * @param string|null $plainTextPassword
+     * @return IShare The share object
+     */
+    public function update(IShare $share, $plainTextPassword = null) {
 
-		$originalShare = $this->getShareById($share->getId());
+        $originalShare = $this->getShareById($share->getId());
 
-		// a real password was given
-		$validPassword = $plainTextPassword !== null && $plainTextPassword !== '';
+        // a real password was given
+        $validPassword = $plainTextPassword !== null && $plainTextPassword !== '';
 
-		if($validPassword && $originalShare->getPassword() !== $share->getPassword()) {
-			$this->sendPassword($share->getNode()->getName(), $share->getSharedBy(), $share->getSharedWith(), $plainTextPassword);
-		}
-		/*
+        if($validPassword && $originalShare->getPassword() !== $share->getPassword()) {
+            $this->sendPassword($share->getNode()->getName(), $share->getSharedBy(), $share->getSharedWith(), $plainTextPassword);
+        }
+        /*
 		 * We allow updating the permissions and password of mail shares
 		 */
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->update('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId())))
-			->set('permissions', $qb->createNamedParameter($share->getPermissions()))
-			->set('uid_owner', $qb->createNamedParameter($share->getShareOwner()))
-			->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy()))
-			->set('password', $qb->createNamedParameter($share->getPassword()))
-			->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE))
-			->execute();
-
-		return $share;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function move(IShare $share, $recipient) {
-		/**
-		 * nothing to do here, mail shares are only outgoing shares
-		 */
-		return $share;
-	}
-
-	/**
-	 * Delete a share (owner unShares the file)
-	 *
-	 * @param IShare $share
-	 */
-	public function delete(IShare $share) {
-		$this->removeShareFromTable($share->getId());
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteFromSelf(IShare $share, $recipient) {
-		// nothing to do here, mail shares are only outgoing shares
-		return;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share');
-
-		$qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
-
-		/**
-		 * Reshares for this user are shares where they are the owner.
-		 */
-		if ($reshares === false) {
-			//Special case for old shares created via the web UI
-			$or1 = $qb->expr()->andX(
-				$qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
-				$qb->expr()->isNull('uid_initiator')
-			);
-
-			$qb->andWhere(
-				$qb->expr()->orX(
-					$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)),
-					$or1
-				)
-			);
-		} else {
-			$qb->andWhere(
-				$qb->expr()->orX(
-					$qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
-					$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
-				)
-			);
-		}
-
-		if ($node !== null) {
-			$qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
-		}
-
-		if ($limit !== -1) {
-			$qb->setMaxResults($limit);
-		}
-
-		$qb->setFirstResult($offset);
-		$qb->orderBy('id');
-
-		$cursor = $qb->execute();
-		$shares = [];
-		while($data = $cursor->fetch()) {
-			$shares[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $shares;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getShareById($id, $recipientId = null) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
-			->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
-
-		$cursor = $qb->execute();
-		$data = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($data === false) {
-			throw new ShareNotFound();
-		}
-
-		try {
-			$share = $this->createShareObject($data);
-		} catch (InvalidShare $e) {
-			throw new ShareNotFound();
-		}
-
-		return $share;
-	}
-
-	/**
-	 * Get shares for a given path
-	 *
-	 * @param \OCP\Files\Node $path
-	 * @return IShare[]
-	 */
-	public function getSharesByPath(Node $path) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$cursor = $qb->select('*')
-			->from('share')
-			->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId())))
-			->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->execute();
-
-		$shares = [];
-		while($data = $cursor->fetch()) {
-			$shares[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $shares;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getSharedWith($userId, $shareType, $node, $limit, $offset) {
-		/** @var IShare[] $shares */
-		$shares = [];
-
-		//Get shares directly with this user
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share');
-
-		// Order by id
-		$qb->orderBy('id');
-
-		// Set limit and offset
-		if ($limit !== -1) {
-			$qb->setMaxResults($limit);
-		}
-		$qb->setFirstResult($offset);
-
-		$qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
-		$qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId)));
-
-		// Filter by node if provided
-		if ($node !== null) {
-			$qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
-		}
-
-		$cursor = $qb->execute();
-
-		while($data = $cursor->fetch()) {
-			$shares[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-
-		return $shares;
-	}
-
-	/**
-	 * Get a share by token
-	 *
-	 * @param string $token
-	 * @return IShare
-	 * @throws ShareNotFound
-	 */
-	public function getShareByToken($token) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$cursor = $qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token)))
-			->execute();
-
-		$data = $cursor->fetch();
-
-		if ($data === false) {
-			throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
-		}
-
-		try {
-			$share = $this->createShareObject($data);
-		} catch (InvalidShare $e) {
-			throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
-		}
-
-		return $share;
-	}
-
-	/**
-	 * remove share from table
-	 *
-	 * @param string $shareId
-	 */
-	protected function removeShareFromTable($shareId) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->delete('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($shareId)));
-		$qb->execute();
-	}
-
-	/**
-	 * Create a share object from an database row
-	 *
-	 * @param array $data
-	 * @return IShare
-	 * @throws InvalidShare
-	 * @throws ShareNotFound
-	 */
-	protected function createShareObject($data) {
-
-		$share = new Share($this->rootFolder, $this->userManager);
-		$share->setId((int)$data['id'])
-			->setShareType((int)$data['share_type'])
-			->setPermissions((int)$data['permissions'])
-			->setTarget($data['file_target'])
-			->setMailSend((bool)$data['mail_send'])
-			->setToken($data['token']);
-
-		$shareTime = new \DateTime();
-		$shareTime->setTimestamp((int)$data['stime']);
-		$share->setShareTime($shareTime);
-		$share->setSharedWith($data['share_with']);
-		$share->setPassword($data['password']);
-
-		if ($data['uid_initiator'] !== null) {
-			$share->setShareOwner($data['uid_owner']);
-			$share->setSharedBy($data['uid_initiator']);
-		} else {
-			//OLD SHARE
-			$share->setSharedBy($data['uid_owner']);
-			$path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
-
-			$owner = $path->getOwner();
-			$share->setShareOwner($owner->getUID());
-		}
-
-		if ($data['expiration'] !== null) {
-			$expiration = \DateTime::createFromFormat('Y-m-d H:i:s', $data['expiration']);
-			if ($expiration !== false) {
-				$share->setExpirationDate($expiration);
-			}
-		}
-
-		$share->setNodeId((int)$data['file_source']);
-		$share->setNodeType($data['item_type']);
-
-		$share->setProviderId($this->identifier());
-
-		return $share;
-	}
-
-	/**
-	 * Get the node with file $id for $user
-	 *
-	 * @param string $userId
-	 * @param int $id
-	 * @return \OCP\Files\File|\OCP\Files\Folder
-	 * @throws InvalidShare
-	 */
-	private function getNode($userId, $id) {
-		try {
-			$userFolder = $this->rootFolder->getUserFolder($userId);
-		} catch (NotFoundException $e) {
-			throw new InvalidShare();
-		}
-
-		$nodes = $userFolder->getById($id);
-
-		if (empty($nodes)) {
-			throw new InvalidShare();
-		}
-
-		return $nodes[0];
-	}
-
-	/**
-	 * A user is deleted from the system
-	 * So clean up the relevant shares.
-	 *
-	 * @param string $uid
-	 * @param int $shareType
-	 */
-	public function userDeleted($uid, $shareType) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$qb->delete('share')
-			->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)))
-			->execute();
-	}
-
-	/**
-	 * This provider does not support group shares
-	 *
-	 * @param string $gid
-	 */
-	public function groupDeleted($gid) {
-		return;
-	}
-
-	/**
-	 * This provider does not support group shares
-	 *
-	 * @param string $uid
-	 * @param string $gid
-	 */
-	public function userDeletedFromGroup($uid, $gid) {
-		return;
-	}
-
-	/**
-	 * get database row of a give share
-	 *
-	 * @param $id
-	 * @return array
-	 * @throws ShareNotFound
-	 */
-	protected function getRawShare($id) {
-
-		// Now fetch the inserted share and create a complete share object
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)));
-
-		$cursor = $qb->execute();
-		$data = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($data === false) {
-			throw new ShareNotFound;
-		}
-
-		return $data;
-	}
-
-	public function getSharesInFolder($userId, Folder $node, $reshares) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share', 's')
-			->andWhere($qb->expr()->orX(
-				$qb->expr()->eq('item_type', $qb->createNamedParameter('file')),
-				$qb->expr()->eq('item_type', $qb->createNamedParameter('folder'))
-			))
-			->andWhere(
-				$qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
-			);
-
-		/**
-		 * Reshares for this user are shares where they are the owner.
-		 */
-		if ($reshares === false) {
-			$qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)));
-		} else {
-			$qb->andWhere(
-				$qb->expr()->orX(
-					$qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
-					$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
-				)
-			);
-		}
-
-		$qb->innerJoin('s', 'filecache' ,'f', $qb->expr()->eq('s.file_source', 'f.fileid'));
-		$qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId())));
-
-		$qb->orderBy('id');
-
-		$cursor = $qb->execute();
-		$shares = [];
-		while ($data = $cursor->fetch()) {
-			$shares[$data['fileid']][] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $shares;
-	}
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->update('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId())))
+            ->set('permissions', $qb->createNamedParameter($share->getPermissions()))
+            ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner()))
+            ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy()))
+            ->set('password', $qb->createNamedParameter($share->getPassword()))
+            ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE))
+            ->execute();
+
+        return $share;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function move(IShare $share, $recipient) {
+        /**
+         * nothing to do here, mail shares are only outgoing shares
+         */
+        return $share;
+    }
+
+    /**
+     * Delete a share (owner unShares the file)
+     *
+     * @param IShare $share
+     */
+    public function delete(IShare $share) {
+        $this->removeShareFromTable($share->getId());
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteFromSelf(IShare $share, $recipient) {
+        // nothing to do here, mail shares are only outgoing shares
+        return;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share');
+
+        $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
+
+        /**
+         * Reshares for this user are shares where they are the owner.
+         */
+        if ($reshares === false) {
+            //Special case for old shares created via the web UI
+            $or1 = $qb->expr()->andX(
+                $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
+                $qb->expr()->isNull('uid_initiator')
+            );
+
+            $qb->andWhere(
+                $qb->expr()->orX(
+                    $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)),
+                    $or1
+                )
+            );
+        } else {
+            $qb->andWhere(
+                $qb->expr()->orX(
+                    $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
+                    $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
+                )
+            );
+        }
+
+        if ($node !== null) {
+            $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
+        }
+
+        if ($limit !== -1) {
+            $qb->setMaxResults($limit);
+        }
+
+        $qb->setFirstResult($offset);
+        $qb->orderBy('id');
+
+        $cursor = $qb->execute();
+        $shares = [];
+        while($data = $cursor->fetch()) {
+            $shares[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $shares;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getShareById($id, $recipientId = null) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
+            ->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
+
+        $cursor = $qb->execute();
+        $data = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($data === false) {
+            throw new ShareNotFound();
+        }
+
+        try {
+            $share = $this->createShareObject($data);
+        } catch (InvalidShare $e) {
+            throw new ShareNotFound();
+        }
+
+        return $share;
+    }
+
+    /**
+     * Get shares for a given path
+     *
+     * @param \OCP\Files\Node $path
+     * @return IShare[]
+     */
+    public function getSharesByPath(Node $path) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $cursor = $qb->select('*')
+            ->from('share')
+            ->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId())))
+            ->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->execute();
+
+        $shares = [];
+        while($data = $cursor->fetch()) {
+            $shares[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $shares;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSharedWith($userId, $shareType, $node, $limit, $offset) {
+        /** @var IShare[] $shares */
+        $shares = [];
+
+        //Get shares directly with this user
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share');
+
+        // Order by id
+        $qb->orderBy('id');
+
+        // Set limit and offset
+        if ($limit !== -1) {
+            $qb->setMaxResults($limit);
+        }
+        $qb->setFirstResult($offset);
+
+        $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
+        $qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId)));
+
+        // Filter by node if provided
+        if ($node !== null) {
+            $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
+        }
+
+        $cursor = $qb->execute();
+
+        while($data = $cursor->fetch()) {
+            $shares[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+
+        return $shares;
+    }
+
+    /**
+     * Get a share by token
+     *
+     * @param string $token
+     * @return IShare
+     * @throws ShareNotFound
+     */
+    public function getShareByToken($token) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $cursor = $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token)))
+            ->execute();
+
+        $data = $cursor->fetch();
+
+        if ($data === false) {
+            throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
+        }
+
+        try {
+            $share = $this->createShareObject($data);
+        } catch (InvalidShare $e) {
+            throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
+        }
+
+        return $share;
+    }
+
+    /**
+     * remove share from table
+     *
+     * @param string $shareId
+     */
+    protected function removeShareFromTable($shareId) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->delete('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($shareId)));
+        $qb->execute();
+    }
+
+    /**
+     * Create a share object from an database row
+     *
+     * @param array $data
+     * @return IShare
+     * @throws InvalidShare
+     * @throws ShareNotFound
+     */
+    protected function createShareObject($data) {
+
+        $share = new Share($this->rootFolder, $this->userManager);
+        $share->setId((int)$data['id'])
+            ->setShareType((int)$data['share_type'])
+            ->setPermissions((int)$data['permissions'])
+            ->setTarget($data['file_target'])
+            ->setMailSend((bool)$data['mail_send'])
+            ->setToken($data['token']);
+
+        $shareTime = new \DateTime();
+        $shareTime->setTimestamp((int)$data['stime']);
+        $share->setShareTime($shareTime);
+        $share->setSharedWith($data['share_with']);
+        $share->setPassword($data['password']);
+
+        if ($data['uid_initiator'] !== null) {
+            $share->setShareOwner($data['uid_owner']);
+            $share->setSharedBy($data['uid_initiator']);
+        } else {
+            //OLD SHARE
+            $share->setSharedBy($data['uid_owner']);
+            $path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
+
+            $owner = $path->getOwner();
+            $share->setShareOwner($owner->getUID());
+        }
+
+        if ($data['expiration'] !== null) {
+            $expiration = \DateTime::createFromFormat('Y-m-d H:i:s', $data['expiration']);
+            if ($expiration !== false) {
+                $share->setExpirationDate($expiration);
+            }
+        }
+
+        $share->setNodeId((int)$data['file_source']);
+        $share->setNodeType($data['item_type']);
+
+        $share->setProviderId($this->identifier());
+
+        return $share;
+    }
+
+    /**
+     * Get the node with file $id for $user
+     *
+     * @param string $userId
+     * @param int $id
+     * @return \OCP\Files\File|\OCP\Files\Folder
+     * @throws InvalidShare
+     */
+    private function getNode($userId, $id) {
+        try {
+            $userFolder = $this->rootFolder->getUserFolder($userId);
+        } catch (NotFoundException $e) {
+            throw new InvalidShare();
+        }
+
+        $nodes = $userFolder->getById($id);
+
+        if (empty($nodes)) {
+            throw new InvalidShare();
+        }
+
+        return $nodes[0];
+    }
+
+    /**
+     * A user is deleted from the system
+     * So clean up the relevant shares.
+     *
+     * @param string $uid
+     * @param int $shareType
+     */
+    public function userDeleted($uid, $shareType) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $qb->delete('share')
+            ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)))
+            ->execute();
+    }
+
+    /**
+     * This provider does not support group shares
+     *
+     * @param string $gid
+     */
+    public function groupDeleted($gid) {
+        return;
+    }
+
+    /**
+     * This provider does not support group shares
+     *
+     * @param string $uid
+     * @param string $gid
+     */
+    public function userDeletedFromGroup($uid, $gid) {
+        return;
+    }
+
+    /**
+     * get database row of a give share
+     *
+     * @param $id
+     * @return array
+     * @throws ShareNotFound
+     */
+    protected function getRawShare($id) {
+
+        // Now fetch the inserted share and create a complete share object
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($id)));
+
+        $cursor = $qb->execute();
+        $data = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($data === false) {
+            throw new ShareNotFound;
+        }
+
+        return $data;
+    }
+
+    public function getSharesInFolder($userId, Folder $node, $reshares) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share', 's')
+            ->andWhere($qb->expr()->orX(
+                $qb->expr()->eq('item_type', $qb->createNamedParameter('file')),
+                $qb->expr()->eq('item_type', $qb->createNamedParameter('folder'))
+            ))
+            ->andWhere(
+                $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
+            );
+
+        /**
+         * Reshares for this user are shares where they are the owner.
+         */
+        if ($reshares === false) {
+            $qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)));
+        } else {
+            $qb->andWhere(
+                $qb->expr()->orX(
+                    $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
+                    $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
+                )
+            );
+        }
+
+        $qb->innerJoin('s', 'filecache' ,'f', $qb->expr()->eq('s.file_source', 'f.fileid'));
+        $qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId())));
+
+        $qb->orderBy('id');
+
+        $cursor = $qb->execute();
+        $shares = [];
+        while ($data = $cursor->fetch()) {
+            $shares[$data['fileid']][] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $shares;
+    }
 
 }

Spacing +22 added lines, -22 removed lines

@@ -234,11 +234,11 @@ 
 				$share->getShareOwner(),
 				$share->getSharedBy(), $share->getSharedWith());
 		} catch (HintException $hintException) {
-			$this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
+			$this->logger->error('Failed to send share by mail: '.$hintException->getMessage());
 			$this->removeShareFromTable($shareId);
 			throw $hintException;
 		} catch (\Exception $e) {
-			$this->logger->error('Failed to send share by mail: ' . $e->getMessage());
+			$this->logger->error('Failed to send share by mail: '.$e->getMessage());
 			$this->removeShareFromTable($shareId);
 			throw new HintException('Failed to send share by mail',
 				$this->l->t('Failed to send share by E-mail'));
@@ -254,9 +254,9 @@ 
 		$ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
 		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
 		if ($owner === $initiator) {
-			$subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
+			$subject = (string) $this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
 		} else {
-			$subject = (string)$this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
+			$subject = (string) $this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
 		}
 
 		$message = $this->mailer->createMessage();
@@ -269,11 +269,11 @@ 
 		if ($owner === $initiator) {
 			$text = $this->l->t('%s shared »%s« with you.', [$ownerDisplayName, $filename]);
 		} else {
-			$text= $this->l->t('%s shared »%s« with you on behalf of %s.', [$ownerDisplayName, $filename, $initiator]);
+			$text = $this->l->t('%s shared »%s« with you on behalf of %s.', [$ownerDisplayName, $filename, $initiator]);
 		}
 
 		$emailTemplate->addBodyText(
-			$text . ' ' . $this->l->t('Click the button below to open it.'),
+			$text.' '.$this->l->t('Click the button below to open it.'),
 			$text
 		);
 
@@ -306,7 +306,7 @@ 
 
 		$initiatorUser = $this->userManager->get($initiator);
 		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
-		$subject = (string)$this->l->t('Password to access »%s« shared to you by %s', [$filename, $initiatorDisplayName]);
+		$subject = (string) $this->l->t('Password to access »%s« shared to you by %s', [$filename, $initiatorDisplayName]);
 
 		$message = $this->mailer->createMessage();
 
@@ -339,7 +339,7 @@ 
 	 */
 	protected function generateToken() {
 		$token = $this->secureRandom->generate(
-			15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
+			15, ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_DIGITS);
 		return $token;
 	}
 
@@ -360,7 +360,7 @@ 
 			->orderBy('id');
 
 		$cursor = $qb->execute();
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$children[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -403,7 +403,7 @@ 
 		$qb->execute();
 		$id = $qb->getLastInsertId();
 
-		return (int)$id;
+		return (int) $id;
 	}
 
 	/**
@@ -420,7 +420,7 @@ 
 		// a real password was given
 		$validPassword = $plainTextPassword !== null && $plainTextPassword !== '';
 
-		if($validPassword && $originalShare->getPassword() !== $share->getPassword()) {
+		if ($validPassword && $originalShare->getPassword() !== $share->getPassword()) {
 			$this->sendPassword($share->getNode()->getName(), $share->getSharedBy(), $share->getSharedWith(), $plainTextPassword);
 		}
 		/*
@@ -514,7 +514,7 @@ 
 
 		$cursor = $qb->execute();
 		$shares = [];
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$shares[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -566,7 +566,7 @@ 
 			->execute();
 
 		$shares = [];
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$shares[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -605,7 +605,7 @@ 
 
 		$cursor = $qb->execute();
 
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$shares[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -668,15 +668,15 @@ 
 	protected function createShareObject($data) {
 
 		$share = new Share($this->rootFolder, $this->userManager);
-		$share->setId((int)$data['id'])
-			->setShareType((int)$data['share_type'])
-			->setPermissions((int)$data['permissions'])
+		$share->setId((int) $data['id'])
+			->setShareType((int) $data['share_type'])
+			->setPermissions((int) $data['permissions'])
 			->setTarget($data['file_target'])
-			->setMailSend((bool)$data['mail_send'])
+			->setMailSend((bool) $data['mail_send'])
 			->setToken($data['token']);
 
 		$shareTime = new \DateTime();
-		$shareTime->setTimestamp((int)$data['stime']);
+		$shareTime->setTimestamp((int) $data['stime']);
 		$share->setShareTime($shareTime);
 		$share->setSharedWith($data['share_with']);
 		$share->setPassword($data['password']);
@@ -687,7 +687,7 @@ 
 		} else {
 			//OLD SHARE
 			$share->setSharedBy($data['uid_owner']);
-			$path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
+			$path = $this->getNode($share->getSharedBy(), (int) $data['file_source']);
 
 			$owner = $path->getOwner();
 			$share->setShareOwner($owner->getUID());
@@ -700,7 +700,7 @@ 
 			}
 		}
 
-		$share->setNodeId((int)$data['file_source']);
+		$share->setNodeId((int) $data['file_source']);
 		$share->setNodeType($data['item_type']);
 
 		$share->setProviderId($this->identifier());
@@ -819,7 +819,7 @@ 
 			);
 		}
 
-		$qb->innerJoin('s', 'filecache' ,'f', $qb->expr()->eq('s.file_source', 'f.fileid'));
+		$qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid'));
 		$qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId())));
 
 		$qb->orderBy('id');

lib/private/Mail/EMailTemplate.php

Doc Comments +1 added lines, -1 removed lines

@@ -335,7 +335,7 @@
 	 * Adds a heading to the email
 	 *
 	 * @param string $title
-	 * @param string $plainTitle|bool Title that is used in the plain text email
+	 * @param string $plainTitle Title that is used in the plain text email
 	 *   if empty the $title is used, if false none will be used
 	 */
 	public function addHeading($title, $plainTitle = '') {

Indentation +223 added lines, -223 removed lines

@@ -39,25 +39,25 @@ 
  * @package OC\Mail
  */
 class EMailTemplate implements IEMailTemplate {
-	/** @var Defaults */
-	protected $themingDefaults;
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IL10N */
-	protected $l10n;
-
-	/** @var string */
-	protected $htmlBody = '';
-	/** @var string */
-	protected $plainBody = '';
-	/** @var bool indicated if the footer is added */
-	protected $headerAdded = false;
-	/** @var bool indicated if the body is already opened */
-	protected $bodyOpened = false;
-	/** @var bool indicated if the footer is added */
-	protected $footerAdded = false;
-
-	protected $head = <<<EOF
+    /** @var Defaults */
+    protected $themingDefaults;
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+    /** @var IL10N */
+    protected $l10n;
+
+    /** @var string */
+    protected $htmlBody = '';
+    /** @var string */
+    protected $plainBody = '';
+    /** @var bool indicated if the footer is added */
+    protected $headerAdded = false;
+    /** @var bool indicated if the body is already opened */
+    protected $bodyOpened = false;
+    /** @var bool indicated if the footer is added */
+    protected $footerAdded = false;
+
+    protected $head = <<<EOF
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en" style="-webkit-font-smoothing:antialiased;background:#f3f3f3!important">
 <head>
@@ -75,7 +75,7 @@ 
 				<center data-parsed="" style="min-width:580px;width:100%">
 EOF;
 
-	protected $tail = <<<EOF
+    protected $tail = <<<EOF
 					</center>
 				</td>
 			</tr>
@@ -86,7 +86,7 @@ 
 </html>
 EOF;
 
-	protected $header = <<<EOF
+    protected $header = <<<EOF
 <table align="center" class="wrapper header float-center" style="Margin:0 auto;background:#8a8a8a;background-color:%s;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:100%%">
 	<tr style="padding:0;text-align:left;vertical-align:top">
 		<td class="wrapper-inner" style="-moz-hyphens:auto;-webkit-hyphens:auto;Margin:0;border-collapse:collapse!important;color:#0a0a0a;font-family:Lucida Grande,Geneva,Verdana,sans-serif;font-size:16px;font-weight:400;hyphens:auto;line-height:1.3;margin:0;padding:20px;text-align:left;vertical-align:top;word-wrap:break-word">
@@ -119,7 +119,7 @@ 
 </table>
 EOF;
 
-	protected $heading = <<<EOF
+    protected $heading = <<<EOF
 <table align="center" class="container main-heading float-center" style="Margin:0 auto;background:0 0!important;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:580px">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -138,7 +138,7 @@ 
 </table>
 EOF;
 
-	protected $bodyBegin = <<<EOF
+    protected $bodyBegin = <<<EOF
 <table align="center" class="wrapper content float-center" style="Margin:0 auto;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:100%">
 	<tr style="padding:0;text-align:left;vertical-align:top">
 		<td class="wrapper-inner" style="-moz-hyphens:auto;-webkit-hyphens:auto;Margin:0;border-collapse:collapse!important;color:#0a0a0a;font-family:Lucida Grande,Geneva,Verdana,sans-serif;font-size:16px;font-weight:400;hyphens:auto;line-height:1.3;margin:0;padding:0;text-align:left;vertical-align:top;word-wrap:break-word">
@@ -155,7 +155,7 @@ 
 						</table>
 EOF;
 
-	protected $bodyText = <<<EOF
+    protected $bodyText = <<<EOF
 <table class="row description" style="border-collapse:collapse;border-spacing:0;display:table;padding:0;position:relative;text-align:left;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -174,7 +174,7 @@ 
 </table>
 EOF;
 
-	protected $buttonGroup = <<<EOF
+    protected $buttonGroup = <<<EOF
 <table class="spacer" style="border-collapse:collapse;border-spacing:0;padding:0;text-align:left;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -227,7 +227,7 @@ 
 </table>
 EOF;
 
-	protected $button = <<<EOF
+    protected $button = <<<EOF
 <table class="spacer" style="border-collapse:collapse;border-spacing:0;padding:0;text-align:left;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -267,7 +267,7 @@ 
 </table>
 EOF;
 
-	protected $bodyEnd = <<<EOF
+    protected $bodyEnd = <<<EOF
 
 					</td>
 				</tr>
@@ -278,7 +278,7 @@ 
 </table>
 EOF;
 
-	protected $footer = <<<EOF
+    protected $footer = <<<EOF
 <table class="spacer float-center" style="Margin:0 auto;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -304,199 +304,199 @@ 
 </table>
 EOF;
 
-	/**
-	 * @param Defaults $themingDefaults
-	 * @param IURLGenerator $urlGenerator
-	 * @param IL10N $l10n
-	 */
-	public function __construct(Defaults $themingDefaults,
-								IURLGenerator $urlGenerator,
-								IL10N $l10n) {
-		$this->themingDefaults = $themingDefaults;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10n = $l10n;
-		$this->htmlBody .= $this->head;
-	}
-
-	/**
-	 * Adds a header to the email
-	 */
-	public function addHeader() {
-		if ($this->headerAdded) {
-			return;
-		}
-		$this->headerAdded = true;
-
-		$logoUrl = $this->urlGenerator->getAbsoluteURL($this->themingDefaults->getLogo());
-		$this->htmlBody .= vsprintf($this->header, [$this->themingDefaults->getColorPrimary(), $logoUrl, $this->themingDefaults->getName()]);
-	}
-
-	/**
-	 * Adds a heading to the email
-	 *
-	 * @param string $title
-	 * @param string $plainTitle|bool Title that is used in the plain text email
-	 *   if empty the $title is used, if false none will be used
-	 */
-	public function addHeading($title, $plainTitle = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-		if ($plainTitle === '') {
-			$plainTitle = $title;
-		}
-
-		$this->htmlBody .= vsprintf($this->heading, [htmlspecialchars($title)]);
-		if ($plainTitle !== false) {
-			$this->plainBody .= $plainTitle . PHP_EOL . PHP_EOL;
-		}
-	}
-
-	/**
-	 * Adds a paragraph to the body of the email
-	 *
-	 * @param string $text
-	 * @param string|bool $plainText Text that is used in the plain text email
-	 *   if empty the $text is used, if false none will be used
-	 */
-	public function addBodyText($text, $plainText = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-		if ($plainText === '') {
-			$plainText = $text;
-		}
-
-		if (!$this->bodyOpened) {
-			$this->htmlBody .= $this->bodyBegin;
-			$this->bodyOpened = true;
-		}
-
-		$this->htmlBody .= vsprintf($this->bodyText, [htmlspecialchars($text)]);
-		if ($plainText !== false) {
-			$this->plainBody .= $plainText . PHP_EOL . PHP_EOL;
-		}
-	}
-
-	/**
-	 * Adds a button group of two buttons to the body of the email
-	 *
-	 * @param string $textLeft Text of left button
-	 * @param string $urlLeft URL of left button
-	 * @param string $textRight Text of right button
-	 * @param string $urlRight URL of right button
-	 * @param string $plainTextLeft Text of left button that is used in the plain text version - if unset the $textLeft is used
-	 * @param string $plainTextRight Text of right button that is used in the plain text version - if unset the $textRight is used
-	 */
-	public function addBodyButtonGroup($textLeft,
-									   $urlLeft,
-									   $textRight,
-									   $urlRight,
-									   $plainTextLeft = '',
-									   $plainTextRight = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-		if ($plainTextLeft === '') {
-			$plainTextLeft = $textLeft;
-		}
-
-		if ($plainTextRight === '') {
-			$plainTextRight = $textRight;
-		}
-
-		if (!$this->bodyOpened) {
-			$this->htmlBody .= $this->bodyBegin;
-			$this->bodyOpened = true;
-		}
-
-		$color = $this->themingDefaults->getColorPrimary();
-
-		$this->htmlBody .= vsprintf($this->buttonGroup, [$color, $color, $urlLeft, $color, htmlspecialchars($textLeft), $urlRight, htmlspecialchars($textRight)]);
-		$this->plainBody .= $plainTextLeft . ': ' . $urlLeft . PHP_EOL;
-		$this->plainBody .= $plainTextRight . ': ' . $urlRight . PHP_EOL . PHP_EOL;
-
-	}
-
-	/**
-	 * Adds a button to the body of the email
-	 *
-	 * @param string $text Text of button
-	 * @param string $url URL of button
-	 *
-	 * @since 12.0.0
-	 */
-	public function addBodyButton($text, $url) {
-		if ($this->footerAdded) {
-			return;
-		}
-
-		if (!$this->bodyOpened) {
-			$this->htmlBody .= $this->bodyBegin;
-			$this->bodyOpened = true;
-		}
-
-		$color = $this->themingDefaults->getColorPrimary();
-		$this->htmlBody .= vsprintf($this->button, [$color, $color, $url, $color, htmlspecialchars($text)]);
-		$this->plainBody .= $text . ': ' . $url . PHP_EOL;
-
-	}
-
-	/**
-	 * Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
-	 *
-	 * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically generated email" will be used
-	 */
-	public function addFooter($text = '') {
-		if($text === '') {
-			$text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan() . '<br>' . $this->l10n->t('This is an automatically generated email, please do not reply.');
-		}
-
-		if ($this->footerAdded) {
-			return;
-		}
-		$this->footerAdded = true;
-
-		if ($this->bodyOpened) {
-			$this->htmlBody .= $this->bodyEnd;
-			$this->bodyOpened = false;
-		}
-
-		$this->htmlBody .= vsprintf($this->footer, [$text]);
-		$this->htmlBody .= $this->tail;
-		$this->plainBody .= PHP_EOL . '-- ' . PHP_EOL;
-		$this->plainBody .= str_replace('<br>', PHP_EOL, $text);
-	}
-
-	/**
-	 * Returns the rendered HTML email as string
-	 *
-	 * @return string
-	 */
-	public function renderHTML() {
-		if (!$this->footerAdded) {
-			$this->footerAdded = true;
-			if ($this->bodyOpened) {
-				$this->htmlBody .= $this->bodyEnd;
-			}
-			$this->htmlBody .= $this->tail;
-		}
-		return $this->htmlBody;
-	}
-
-	/**
-	 * Returns the rendered plain text email as string
-	 *
-	 * @return string
-	 */
-	public function renderText() {
-		if (!$this->footerAdded) {
-			$this->footerAdded = true;
-			if ($this->bodyOpened) {
-				$this->htmlBody .= $this->bodyEnd;
-			}
-			$this->htmlBody .= $this->tail;
-		}
-		return $this->plainBody;
-	}
+    /**
+     * @param Defaults $themingDefaults
+     * @param IURLGenerator $urlGenerator
+     * @param IL10N $l10n
+     */
+    public function __construct(Defaults $themingDefaults,
+                                IURLGenerator $urlGenerator,
+                                IL10N $l10n) {
+        $this->themingDefaults = $themingDefaults;
+        $this->urlGenerator = $urlGenerator;
+        $this->l10n = $l10n;
+        $this->htmlBody .= $this->head;
+    }
+
+    /**
+     * Adds a header to the email
+     */
+    public function addHeader() {
+        if ($this->headerAdded) {
+            return;
+        }
+        $this->headerAdded = true;
+
+        $logoUrl = $this->urlGenerator->getAbsoluteURL($this->themingDefaults->getLogo());
+        $this->htmlBody .= vsprintf($this->header, [$this->themingDefaults->getColorPrimary(), $logoUrl, $this->themingDefaults->getName()]);
+    }
+
+    /**
+     * Adds a heading to the email
+     *
+     * @param string $title
+     * @param string $plainTitle|bool Title that is used in the plain text email
+     *   if empty the $title is used, if false none will be used
+     */
+    public function addHeading($title, $plainTitle = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+        if ($plainTitle === '') {
+            $plainTitle = $title;
+        }
+
+        $this->htmlBody .= vsprintf($this->heading, [htmlspecialchars($title)]);
+        if ($plainTitle !== false) {
+            $this->plainBody .= $plainTitle . PHP_EOL . PHP_EOL;
+        }
+    }
+
+    /**
+     * Adds a paragraph to the body of the email
+     *
+     * @param string $text
+     * @param string|bool $plainText Text that is used in the plain text email
+     *   if empty the $text is used, if false none will be used
+     */
+    public function addBodyText($text, $plainText = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+        if ($plainText === '') {
+            $plainText = $text;
+        }
+
+        if (!$this->bodyOpened) {
+            $this->htmlBody .= $this->bodyBegin;
+            $this->bodyOpened = true;
+        }
+
+        $this->htmlBody .= vsprintf($this->bodyText, [htmlspecialchars($text)]);
+        if ($plainText !== false) {
+            $this->plainBody .= $plainText . PHP_EOL . PHP_EOL;
+        }
+    }
+
+    /**
+     * Adds a button group of two buttons to the body of the email
+     *
+     * @param string $textLeft Text of left button
+     * @param string $urlLeft URL of left button
+     * @param string $textRight Text of right button
+     * @param string $urlRight URL of right button
+     * @param string $plainTextLeft Text of left button that is used in the plain text version - if unset the $textLeft is used
+     * @param string $plainTextRight Text of right button that is used in the plain text version - if unset the $textRight is used
+     */
+    public function addBodyButtonGroup($textLeft,
+                                        $urlLeft,
+                                        $textRight,
+                                        $urlRight,
+                                        $plainTextLeft = '',
+                                        $plainTextRight = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+        if ($plainTextLeft === '') {
+            $plainTextLeft = $textLeft;
+        }
+
+        if ($plainTextRight === '') {
+            $plainTextRight = $textRight;
+        }
+
+        if (!$this->bodyOpened) {
+            $this->htmlBody .= $this->bodyBegin;
+            $this->bodyOpened = true;
+        }
+
+        $color = $this->themingDefaults->getColorPrimary();
+
+        $this->htmlBody .= vsprintf($this->buttonGroup, [$color, $color, $urlLeft, $color, htmlspecialchars($textLeft), $urlRight, htmlspecialchars($textRight)]);
+        $this->plainBody .= $plainTextLeft . ': ' . $urlLeft . PHP_EOL;
+        $this->plainBody .= $plainTextRight . ': ' . $urlRight . PHP_EOL . PHP_EOL;
+
+    }
+
+    /**
+     * Adds a button to the body of the email
+     *
+     * @param string $text Text of button
+     * @param string $url URL of button
+     *
+     * @since 12.0.0
+     */
+    public function addBodyButton($text, $url) {
+        if ($this->footerAdded) {
+            return;
+        }
+
+        if (!$this->bodyOpened) {
+            $this->htmlBody .= $this->bodyBegin;
+            $this->bodyOpened = true;
+        }
+
+        $color = $this->themingDefaults->getColorPrimary();
+        $this->htmlBody .= vsprintf($this->button, [$color, $color, $url, $color, htmlspecialchars($text)]);
+        $this->plainBody .= $text . ': ' . $url . PHP_EOL;
+
+    }
+
+    /**
+     * Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
+     *
+     * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically generated email" will be used
+     */
+    public function addFooter($text = '') {
+        if($text === '') {
+            $text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan() . '<br>' . $this->l10n->t('This is an automatically generated email, please do not reply.');
+        }
+
+        if ($this->footerAdded) {
+            return;
+        }
+        $this->footerAdded = true;
+
+        if ($this->bodyOpened) {
+            $this->htmlBody .= $this->bodyEnd;
+            $this->bodyOpened = false;
+        }
+
+        $this->htmlBody .= vsprintf($this->footer, [$text]);
+        $this->htmlBody .= $this->tail;
+        $this->plainBody .= PHP_EOL . '-- ' . PHP_EOL;
+        $this->plainBody .= str_replace('<br>', PHP_EOL, $text);
+    }
+
+    /**
+     * Returns the rendered HTML email as string
+     *
+     * @return string
+     */
+    public function renderHTML() {
+        if (!$this->footerAdded) {
+            $this->footerAdded = true;
+            if ($this->bodyOpened) {
+                $this->htmlBody .= $this->bodyEnd;
+            }
+            $this->htmlBody .= $this->tail;
+        }
+        return $this->htmlBody;
+    }
+
+    /**
+     * Returns the rendered plain text email as string
+     *
+     * @return string
+     */
+    public function renderText() {
+        if (!$this->footerAdded) {
+            $this->footerAdded = true;
+            if ($this->bodyOpened) {
+                $this->htmlBody .= $this->bodyEnd;
+            }
+            $this->htmlBody .= $this->tail;
+        }
+        return $this->plainBody;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -348,7 +348,7 @@ 
 
 		$this->htmlBody .= vsprintf($this->heading, [htmlspecialchars($title)]);
 		if ($plainTitle !== false) {
-			$this->plainBody .= $plainTitle . PHP_EOL . PHP_EOL;
+			$this->plainBody .= $plainTitle.PHP_EOL.PHP_EOL;
 		}
 	}
 
@@ -374,7 +374,7 @@ 
 
 		$this->htmlBody .= vsprintf($this->bodyText, [htmlspecialchars($text)]);
 		if ($plainText !== false) {
-			$this->plainBody .= $plainText . PHP_EOL . PHP_EOL;
+			$this->plainBody .= $plainText.PHP_EOL.PHP_EOL;
 		}
 	}
 
@@ -413,8 +413,8 @@ 
 		$color = $this->themingDefaults->getColorPrimary();
 
 		$this->htmlBody .= vsprintf($this->buttonGroup, [$color, $color, $urlLeft, $color, htmlspecialchars($textLeft), $urlRight, htmlspecialchars($textRight)]);
-		$this->plainBody .= $plainTextLeft . ': ' . $urlLeft . PHP_EOL;
-		$this->plainBody .= $plainTextRight . ': ' . $urlRight . PHP_EOL . PHP_EOL;
+		$this->plainBody .= $plainTextLeft.': '.$urlLeft.PHP_EOL;
+		$this->plainBody .= $plainTextRight.': '.$urlRight.PHP_EOL.PHP_EOL;
 
 	}
 
@@ -438,7 +438,7 @@ 
 
 		$color = $this->themingDefaults->getColorPrimary();
 		$this->htmlBody .= vsprintf($this->button, [$color, $color, $url, $color, htmlspecialchars($text)]);
-		$this->plainBody .= $text . ': ' . $url . PHP_EOL;
+		$this->plainBody .= $text.': '.$url.PHP_EOL;
 
 	}
 
@@ -448,8 +448,8 @@ 
 	 * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically generated email" will be used
 	 */
 	public function addFooter($text = '') {
-		if($text === '') {
-			$text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan() . '<br>' . $this->l10n->t('This is an automatically generated email, please do not reply.');
+		if ($text === '') {
+			$text = $this->themingDefaults->getName().' - '.$this->themingDefaults->getSlogan().'<br>'.$this->l10n->t('This is an automatically generated email, please do not reply.');
 		}
 
 		if ($this->footerAdded) {
@@ -464,7 +464,7 @@ 
 
 		$this->htmlBody .= vsprintf($this->footer, [$text]);
 		$this->htmlBody .= $this->tail;
-		$this->plainBody .= PHP_EOL . '-- ' . PHP_EOL;
+		$this->plainBody .= PHP_EOL.'-- '.PHP_EOL;
 		$this->plainBody .= str_replace('<br>', PHP_EOL, $text);
 	}
 

lib/public/Mail/IEMailTemplate.php

Doc Comments +7 added lines, -1 removed lines

@@ -55,6 +55,7 @@ 
 	 * Adds a header to the email
 	 *
 	 * @since 12.0.0
+	 * @return void
 	 */
 	public function addHeader();
 
@@ -62,10 +63,11 @@ 
 	 * Adds a heading to the email
 	 *
 	 * @param string $title
-	 * @param string $plainTitle|bool Title that is used in the plain text email
+	 * @param string $plainTitle Title that is used in the plain text email
 	 *   if empty the $title is used, if false none will be used
 	 *
 	 * @since 12.0.0
+	 * @return void
 	 */
 	public function addHeading($title, $plainTitle = '');
 
@@ -77,6 +79,7 @@ 
 	 *   if empty the $text is used, if false none will be used
 	 *
 	 * @since 12.0.0
+	 * @return void
 	 */
 	public function addBodyText($text, $plainText = '');
 
@@ -91,6 +94,7 @@ 
 	 * @param string $plainTextRight Text of right button that is used in the plain text version - if empty the $textRight is used
 	 *
 	 * @since 12.0.0
+	 * @return void
 	 */
 	public function addBodyButtonGroup($textLeft, $urlLeft, $textRight, $urlRight, $plainTextLeft = '', $plainTextRight = '');
 
@@ -101,6 +105,7 @@ 
 	 * @param string $url URL of button
 	 *
 	 * @since 12.0.0
+	 * @return void
 	 */
 	public function addBodyButton($text, $url);
 
@@ -110,6 +115,7 @@ 
 	 * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically generated email" will be used
 	 *
 	 * @since 12.0.0
+	 * @return void
 	 */
 	public function addFooter($text = '');
 

Indentation +72 added lines, -72 removed lines

@@ -51,83 +51,83 @@
  * @since 12.0.0
  */
 interface IEMailTemplate {
-	/**
-	 * Adds a header to the email
-	 *
-	 * @since 12.0.0
-	 */
-	public function addHeader();
+    /**
+     * Adds a header to the email
+     *
+     * @since 12.0.0
+     */
+    public function addHeader();
 
-	/**
-	 * Adds a heading to the email
-	 *
-	 * @param string $title
-	 * @param string $plainTitle|bool Title that is used in the plain text email
-	 *   if empty the $title is used, if false none will be used
-	 *
-	 * @since 12.0.0
-	 */
-	public function addHeading($title, $plainTitle = '');
+    /**
+     * Adds a heading to the email
+     *
+     * @param string $title
+     * @param string $plainTitle|bool Title that is used in the plain text email
+     *   if empty the $title is used, if false none will be used
+     *
+     * @since 12.0.0
+     */
+    public function addHeading($title, $plainTitle = '');
 
-	/**
-	 * Adds a paragraph to the body of the email
-	 *
-	 * @param string $text
-	 * @param string|bool $plainText Text that is used in the plain text email
-	 *   if empty the $text is used, if false none will be used
-	 *
-	 * @since 12.0.0
-	 */
-	public function addBodyText($text, $plainText = '');
+    /**
+     * Adds a paragraph to the body of the email
+     *
+     * @param string $text
+     * @param string|bool $plainText Text that is used in the plain text email
+     *   if empty the $text is used, if false none will be used
+     *
+     * @since 12.0.0
+     */
+    public function addBodyText($text, $plainText = '');
 
-	/**
-	 * Adds a button group of two buttons to the body of the email
-	 *
-	 * @param string $textLeft Text of left button
-	 * @param string $urlLeft URL of left button
-	 * @param string $textRight Text of right button
-	 * @param string $urlRight URL of right button
-	 * @param string $plainTextLeft Text of left button that is used in the plain text version - if empty the $textLeft is used
-	 * @param string $plainTextRight Text of right button that is used in the plain text version - if empty the $textRight is used
-	 *
-	 * @since 12.0.0
-	 */
-	public function addBodyButtonGroup($textLeft, $urlLeft, $textRight, $urlRight, $plainTextLeft = '', $plainTextRight = '');
+    /**
+     * Adds a button group of two buttons to the body of the email
+     *
+     * @param string $textLeft Text of left button
+     * @param string $urlLeft URL of left button
+     * @param string $textRight Text of right button
+     * @param string $urlRight URL of right button
+     * @param string $plainTextLeft Text of left button that is used in the plain text version - if empty the $textLeft is used
+     * @param string $plainTextRight Text of right button that is used in the plain text version - if empty the $textRight is used
+     *
+     * @since 12.0.0
+     */
+    public function addBodyButtonGroup($textLeft, $urlLeft, $textRight, $urlRight, $plainTextLeft = '', $plainTextRight = '');
 
-	/**
-	 * Adds a button to the body of the email
-	 *
-	 * @param string $text Text of button
-	 * @param string $url URL of button
-	 *
-	 * @since 12.0.0
-	 */
-	public function addBodyButton($text, $url);
+    /**
+     * Adds a button to the body of the email
+     *
+     * @param string $text Text of button
+     * @param string $url URL of button
+     *
+     * @since 12.0.0
+     */
+    public function addBodyButton($text, $url);
 
-	/**
-	 * Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
-	 *
-	 * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically generated email" will be used
-	 *
-	 * @since 12.0.0
-	 */
-	public function addFooter($text = '');
+    /**
+     * Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
+     *
+     * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically generated email" will be used
+     *
+     * @since 12.0.0
+     */
+    public function addFooter($text = '');
 
-	/**
-	 * Returns the rendered HTML email as string
-	 *
-	 * @return string
-	 *
-	 * @since 12.0.0
-	 */
-	public function renderHTML();
+    /**
+     * Returns the rendered HTML email as string
+     *
+     * @return string
+     *
+     * @since 12.0.0
+     */
+    public function renderHTML();
 
-	/**
-	 * Returns the rendered plain text email as string
-	 *
-	 * @return string
-	 *
-	 * @since 12.0.0
-	 */
-	public function renderText();
+    /**
+     * Returns the rendered plain text email as string
+     *
+     * @return string
+     *
+     * @since 12.0.0
+     */
+    public function renderText();
 }