Inspection of "Set the meta data before everything" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6358)

by Joas

created 2017-09-04 12:58 UTC

Status

Indentation +126 added lines, -126 removed lines patch added patch discarded remove patch

@@ -33,137 +33,137 @@
 block discarded – undo
 use OCP\Security\ISecureRandom;
 
 class NewUserMailHelper {
-	/** @var Defaults */
-	private $themingDefaults;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var IL10N */
-	private $l10n;
-	/** @var IMailer */
-	private $mailer;
-	/** @var ISecureRandom */
-	private $secureRandom;
-	/** @var ITimeFactory */
-	private $timeFactory;
-	/** @var IConfig */
-	private $config;
-	/** @var ICrypto */
-	private $crypto;
-	/** @var string */
-	private $fromAddress;
+    /** @var Defaults */
+    private $themingDefaults;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var IL10N */
+    private $l10n;
+    /** @var IMailer */
+    private $mailer;
+    /** @var ISecureRandom */
+    private $secureRandom;
+    /** @var ITimeFactory */
+    private $timeFactory;
+    /** @var IConfig */
+    private $config;
+    /** @var ICrypto */
+    private $crypto;
+    /** @var string */
+    private $fromAddress;
 
-	/**
-	 * @param Defaults $themingDefaults
-	 * @param IURLGenerator $urlGenerator
-	 * @param IL10N $l10n
-	 * @param IMailer $mailer
-	 * @param ISecureRandom $secureRandom
-	 * @param ITimeFactory $timeFactory
-	 * @param IConfig $config
-	 * @param ICrypto $crypto
-	 * @param string $fromAddress
-	 */
-	public function __construct(Defaults $themingDefaults,
-								IURLGenerator $urlGenerator,
-								IL10N $l10n,
-								IMailer $mailer,
-								ISecureRandom $secureRandom,
-								ITimeFactory $timeFactory,
-								IConfig $config,
-								ICrypto $crypto,
-								$fromAddress) {
-		$this->themingDefaults = $themingDefaults;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10n = $l10n;
-		$this->mailer = $mailer;
-		$this->secureRandom = $secureRandom;
-		$this->timeFactory = $timeFactory;
-		$this->config = $config;
-		$this->crypto = $crypto;
-		$this->fromAddress = $fromAddress;
-	}
+    /**
+     * @param Defaults $themingDefaults
+     * @param IURLGenerator $urlGenerator
+     * @param IL10N $l10n
+     * @param IMailer $mailer
+     * @param ISecureRandom $secureRandom
+     * @param ITimeFactory $timeFactory
+     * @param IConfig $config
+     * @param ICrypto $crypto
+     * @param string $fromAddress
+     */
+    public function __construct(Defaults $themingDefaults,
+                                IURLGenerator $urlGenerator,
+                                IL10N $l10n,
+                                IMailer $mailer,
+                                ISecureRandom $secureRandom,
+                                ITimeFactory $timeFactory,
+                                IConfig $config,
+                                ICrypto $crypto,
+                                $fromAddress) {
+        $this->themingDefaults = $themingDefaults;
+        $this->urlGenerator = $urlGenerator;
+        $this->l10n = $l10n;
+        $this->mailer = $mailer;
+        $this->secureRandom = $secureRandom;
+        $this->timeFactory = $timeFactory;
+        $this->config = $config;
+        $this->crypto = $crypto;
+        $this->fromAddress = $fromAddress;
+    }
 
-	/**
-	 * Set the IL10N object
-	 *
-	 * @param IL10N $l10n
-	 */
-	public function setL10N(IL10N $l10n) {
-		$this->l10n = $l10n;
-	}
+    /**
+     * Set the IL10N object
+     *
+     * @param IL10N $l10n
+     */
+    public function setL10N(IL10N $l10n) {
+        $this->l10n = $l10n;
+    }
 
-	/**
-	 * @param IUser $user
-	 * @param bool $generatePasswordResetToken
-	 * @return IEMailTemplate
-	 */
-	public function generateTemplate(IUser $user, $generatePasswordResetToken = false) {
-		if ($generatePasswordResetToken) {
-			$token = $this->secureRandom->generate(
-				21,
-				ISecureRandom::CHAR_DIGITS .
-				ISecureRandom::CHAR_LOWER .
-				ISecureRandom::CHAR_UPPER
-			);
-			$tokenValue = $this->timeFactory->getTime() . ':' . $token;
-			$mailAddress = (null !== $user->getEMailAddress()) ? $user->getEMailAddress() : '';
-			$encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress . $this->config->getSystemValue('secret'));
-			$this->config->setUserValue($user->getUID(), 'core', 'lostpassword', $encryptedValue);
-			$link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', ['userId' => $user->getUID(), 'token' => $token]);
-		} else {
-			$link = $this->urlGenerator->getAbsoluteURL('/');
-		}
-		$displayName = $user->getDisplayName();
-		$userId = $user->getUID();
+    /**
+     * @param IUser $user
+     * @param bool $generatePasswordResetToken
+     * @return IEMailTemplate
+     */
+    public function generateTemplate(IUser $user, $generatePasswordResetToken = false) {
+        if ($generatePasswordResetToken) {
+            $token = $this->secureRandom->generate(
+                21,
+                ISecureRandom::CHAR_DIGITS .
+                ISecureRandom::CHAR_LOWER .
+                ISecureRandom::CHAR_UPPER
+            );
+            $tokenValue = $this->timeFactory->getTime() . ':' . $token;
+            $mailAddress = (null !== $user->getEMailAddress()) ? $user->getEMailAddress() : '';
+            $encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress . $this->config->getSystemValue('secret'));
+            $this->config->setUserValue($user->getUID(), 'core', 'lostpassword', $encryptedValue);
+            $link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', ['userId' => $user->getUID(), 'token' => $token]);
+        } else {
+            $link = $this->urlGenerator->getAbsoluteURL('/');
+        }
+        $displayName = $user->getDisplayName();
+        $userId = $user->getUID();
 
-		$emailTemplate = $this->mailer->createEMailTemplate();
-		$emailTemplate->setMetaData('settings.Welcome', [
-			'link' => $link,
-			'displayname' => $displayName,
-			'userid' => $userId,
-			'instancename' => $this->themingDefaults->getName(),
-			'resetTokenGenerated' => $generatePasswordResetToken,
-		]);
+        $emailTemplate = $this->mailer->createEMailTemplate();
+        $emailTemplate->setMetaData('settings.Welcome', [
+            'link' => $link,
+            'displayname' => $displayName,
+            'userid' => $userId,
+            'instancename' => $this->themingDefaults->getName(),
+            'resetTokenGenerated' => $generatePasswordResetToken,
+        ]);
 
-		$emailTemplate->addHeader();
-		if ($displayName === $userId) {
-			$emailTemplate->addHeading($this->l10n->t('Welcome aboard'));
-		} else {
-			$emailTemplate->addHeading($this->l10n->t('Welcome aboard %s', [$displayName]));
-		}
-		$emailTemplate->addBodyText($this->l10n->t('You have now an %s account, you can add, protect, and share your data.', [$this->themingDefaults->getName()]));
-		$emailTemplate->addBodyText($this->l10n->t('Your username is: %s', [$userId]));
-		if ($generatePasswordResetToken) {
-			$leftButtonText = $this->l10n->t('Set your password');
-		} else {
-			$leftButtonText = $this->l10n->t('Go to %s', [$this->themingDefaults->getName()]);
-		}
-		$emailTemplate->addBodyButtonGroup(
-			$leftButtonText,
-			$link,
-			$this->l10n->t('Install Client'),
-			'https://nextcloud.com/install/#install-clients'
-		);
-		$emailTemplate->addFooter();
+        $emailTemplate->addHeader();
+        if ($displayName === $userId) {
+            $emailTemplate->addHeading($this->l10n->t('Welcome aboard'));
+        } else {
+            $emailTemplate->addHeading($this->l10n->t('Welcome aboard %s', [$displayName]));
+        }
+        $emailTemplate->addBodyText($this->l10n->t('You have now an %s account, you can add, protect, and share your data.', [$this->themingDefaults->getName()]));
+        $emailTemplate->addBodyText($this->l10n->t('Your username is: %s', [$userId]));
+        if ($generatePasswordResetToken) {
+            $leftButtonText = $this->l10n->t('Set your password');
+        } else {
+            $leftButtonText = $this->l10n->t('Go to %s', [$this->themingDefaults->getName()]);
+        }
+        $emailTemplate->addBodyButtonGroup(
+            $leftButtonText,
+            $link,
+            $this->l10n->t('Install Client'),
+            'https://nextcloud.com/install/#install-clients'
+        );
+        $emailTemplate->addFooter();
 
-		return $emailTemplate;
-	}
+        return $emailTemplate;
+    }
 
-	/**
-	 * Sends a welcome mail to $user
-	 *
-	 * @param IUser $user
-	 * @param IEmailTemplate $emailTemplate
-	 * @throws \Exception If mail could not be sent
-	 */
-	public function sendMail(IUser $user,
-							 IEMailTemplate $emailTemplate) {
-		$message = $this->mailer->createMessage();
-		$message->setTo([$user->getEMailAddress() => $user->getDisplayName()]);
-		$message->setSubject($this->l10n->t('Your %s account was created', [$this->themingDefaults->getName()]));
-		$message->setHtmlBody($emailTemplate->renderHtml());
-		$message->setPlainBody($emailTemplate->renderText());
-		$message->setFrom([$this->fromAddress => $this->themingDefaults->getName()]);
-		$this->mailer->send($message);
-	}
+    /**
+     * Sends a welcome mail to $user
+     *
+     * @param IUser $user
+     * @param IEmailTemplate $emailTemplate
+     * @throws \Exception If mail could not be sent
+     */
+    public function sendMail(IUser $user,
+                                IEMailTemplate $emailTemplate) {
+        $message = $this->mailer->createMessage();
+        $message->setTo([$user->getEMailAddress() => $user->getDisplayName()]);
+        $message->setSubject($this->l10n->t('Your %s account was created', [$this->themingDefaults->getName()]));
+        $message->setHtmlBody($emailTemplate->renderHtml());
+        $message->setPlainBody($emailTemplate->renderText());
+        $message->setFrom([$this->fromAddress => $this->themingDefaults->getName()]);
+        $this->mailer->send($message);
+    }
 }

Please login to merge, or discard this patch.

		@@ -33,137 +33,137 @@
		block discarded – undo
33	33	use OCP\Security\ISecureRandom;
34	34
35	35	class NewUserMailHelper {
36		- /** @var Defaults */
37		- private $themingDefaults;
38		- /** @var IURLGenerator */
39		- private $urlGenerator;
40		- /** @var IL10N */
41		- private $l10n;
42		- /** @var IMailer */
43		- private $mailer;
44		- /** @var ISecureRandom */
45		- private $secureRandom;
46		- /** @var ITimeFactory */
47		- private $timeFactory;
48		- /** @var IConfig */
49		- private $config;
50		- /** @var ICrypto */
51		- private $crypto;
52		- /** @var string */
53		- private $fromAddress;
	36	+ /** @var Defaults */
	37	+ private $themingDefaults;
	38	+ /** @var IURLGenerator */
	39	+ private $urlGenerator;
	40	+ /** @var IL10N */
	41	+ private $l10n;
	42	+ /** @var IMailer */
	43	+ private $mailer;
	44	+ /** @var ISecureRandom */
	45	+ private $secureRandom;
	46	+ /** @var ITimeFactory */
	47	+ private $timeFactory;
	48	+ /** @var IConfig */
	49	+ private $config;
	50	+ /** @var ICrypto */
	51	+ private $crypto;
	52	+ /** @var string */
	53	+ private $fromAddress;
54	54
55		- /**
56		- * @param Defaults $themingDefaults
57		- * @param IURLGenerator $urlGenerator
58		- * @param IL10N $l10n
59		- * @param IMailer $mailer
60		- * @param ISecureRandom $secureRandom
61		- * @param ITimeFactory $timeFactory
62		- * @param IConfig $config
63		- * @param ICrypto $crypto
64		- * @param string $fromAddress
65		- */
66		- public function __construct(Defaults $themingDefaults,
67		- IURLGenerator $urlGenerator,
68		- IL10N $l10n,
69		- IMailer $mailer,
70		- ISecureRandom $secureRandom,
71		- ITimeFactory $timeFactory,
72		- IConfig $config,
73		- ICrypto $crypto,
74		- $fromAddress) {
75		- $this->themingDefaults = $themingDefaults;
76		- $this->urlGenerator = $urlGenerator;
77		- $this->l10n = $l10n;
78		- $this->mailer = $mailer;
79		- $this->secureRandom = $secureRandom;
80		- $this->timeFactory = $timeFactory;
81		- $this->config = $config;
82		- $this->crypto = $crypto;
83		- $this->fromAddress = $fromAddress;
84		- }
	55	+ /**
	56	+ * @param Defaults $themingDefaults
	57	+ * @param IURLGenerator $urlGenerator
	58	+ * @param IL10N $l10n
	59	+ * @param IMailer $mailer
	60	+ * @param ISecureRandom $secureRandom
	61	+ * @param ITimeFactory $timeFactory
	62	+ * @param IConfig $config
	63	+ * @param ICrypto $crypto
	64	+ * @param string $fromAddress
	65	+ */
	66	+ public function __construct(Defaults $themingDefaults,
	67	+ IURLGenerator $urlGenerator,
	68	+ IL10N $l10n,
	69	+ IMailer $mailer,
	70	+ ISecureRandom $secureRandom,
	71	+ ITimeFactory $timeFactory,
	72	+ IConfig $config,
	73	+ ICrypto $crypto,
	74	+ $fromAddress) {
	75	+ $this->themingDefaults = $themingDefaults;
	76	+ $this->urlGenerator = $urlGenerator;
	77	+ $this->l10n = $l10n;
	78	+ $this->mailer = $mailer;
	79	+ $this->secureRandom = $secureRandom;
	80	+ $this->timeFactory = $timeFactory;
	81	+ $this->config = $config;
	82	+ $this->crypto = $crypto;
	83	+ $this->fromAddress = $fromAddress;
	84	+ }
85	85
86		- /**
87		- * Set the IL10N object
88		- *
89		- * @param IL10N $l10n
90		- */
91		- public function setL10N(IL10N $l10n) {
92		- $this->l10n = $l10n;
93		- }
	86	+ /**
	87	+ * Set the IL10N object
	88	+ *
	89	+ * @param IL10N $l10n
	90	+ */
	91	+ public function setL10N(IL10N $l10n) {
	92	+ $this->l10n = $l10n;
	93	+ }
94	94
95		- /**
96		- * @param IUser $user
97		- * @param bool $generatePasswordResetToken
98		- * @return IEMailTemplate
99		- */
100		- public function generateTemplate(IUser $user, $generatePasswordResetToken = false) {
101		- if ($generatePasswordResetToken) {
102		- $token = $this->secureRandom->generate(
103		- 21,
104		- ISecureRandom::CHAR_DIGITS .
105		- ISecureRandom::CHAR_LOWER .
106		- ISecureRandom::CHAR_UPPER
107		- );
108		- $tokenValue = $this->timeFactory->getTime() . ':' . $token;
109		- $mailAddress = (null !== $user->getEMailAddress()) ? $user->getEMailAddress() : '';
110		- $encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress . $this->config->getSystemValue('secret'));
111		- $this->config->setUserValue($user->getUID(), 'core', 'lostpassword', $encryptedValue);
112		- $link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', ['userId' => $user->getUID(), 'token' => $token]);
113		- } else {
114		- $link = $this->urlGenerator->getAbsoluteURL('/');
115		- }
116		- $displayName = $user->getDisplayName();
117		- $userId = $user->getUID();
	95	+ /**
	96	+ * @param IUser $user
	97	+ * @param bool $generatePasswordResetToken
	98	+ * @return IEMailTemplate
	99	+ */
	100	+ public function generateTemplate(IUser $user, $generatePasswordResetToken = false) {
	101	+ if ($generatePasswordResetToken) {
	102	+ $token = $this->secureRandom->generate(
	103	+ 21,
	104	+ ISecureRandom::CHAR_DIGITS .
	105	+ ISecureRandom::CHAR_LOWER .
	106	+ ISecureRandom::CHAR_UPPER
	107	+ );
	108	+ $tokenValue = $this->timeFactory->getTime() . ':' . $token;
	109	+ $mailAddress = (null !== $user->getEMailAddress()) ? $user->getEMailAddress() : '';
	110	+ $encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress . $this->config->getSystemValue('secret'));
	111	+ $this->config->setUserValue($user->getUID(), 'core', 'lostpassword', $encryptedValue);
	112	+ $link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', ['userId' => $user->getUID(), 'token' => $token]);
	113	+ } else {
	114	+ $link = $this->urlGenerator->getAbsoluteURL('/');
	115	+ }
	116	+ $displayName = $user->getDisplayName();
	117	+ $userId = $user->getUID();
118	118
119		- $emailTemplate = $this->mailer->createEMailTemplate();
120		- $emailTemplate->setMetaData('settings.Welcome', [
121		- 'link' => $link,
122		- 'displayname' => $displayName,
123		- 'userid' => $userId,
124		- 'instancename' => $this->themingDefaults->getName(),
125		- 'resetTokenGenerated' => $generatePasswordResetToken,
126		- ]);
	119	+ $emailTemplate = $this->mailer->createEMailTemplate();
	120	+ $emailTemplate->setMetaData('settings.Welcome', [
	121	+ 'link' => $link,
	122	+ 'displayname' => $displayName,
	123	+ 'userid' => $userId,
	124	+ 'instancename' => $this->themingDefaults->getName(),
	125	+ 'resetTokenGenerated' => $generatePasswordResetToken,
	126	+ ]);
127	127
128		- $emailTemplate->addHeader();
129		- if ($displayName === $userId) {
130		- $emailTemplate->addHeading($this->l10n->t('Welcome aboard'));
131		- } else {
132		- $emailTemplate->addHeading($this->l10n->t('Welcome aboard %s', [$displayName]));
133		- }
134		- $emailTemplate->addBodyText($this->l10n->t('You have now an %s account, you can add, protect, and share your data.', [$this->themingDefaults->getName()]));
135		- $emailTemplate->addBodyText($this->l10n->t('Your username is: %s', [$userId]));
136		- if ($generatePasswordResetToken) {
137		- $leftButtonText = $this->l10n->t('Set your password');
138		- } else {
139		- $leftButtonText = $this->l10n->t('Go to %s', [$this->themingDefaults->getName()]);
140		- }
141		- $emailTemplate->addBodyButtonGroup(
142		- $leftButtonText,
143		- $link,
144		- $this->l10n->t('Install Client'),
145		- 'https://nextcloud.com/install/#install-clients'
146		- );
147		- $emailTemplate->addFooter();
	128	+ $emailTemplate->addHeader();
	129	+ if ($displayName === $userId) {
	130	+ $emailTemplate->addHeading($this->l10n->t('Welcome aboard'));
	131	+ } else {
	132	+ $emailTemplate->addHeading($this->l10n->t('Welcome aboard %s', [$displayName]));
	133	+ }
	134	+ $emailTemplate->addBodyText($this->l10n->t('You have now an %s account, you can add, protect, and share your data.', [$this->themingDefaults->getName()]));
	135	+ $emailTemplate->addBodyText($this->l10n->t('Your username is: %s', [$userId]));
	136	+ if ($generatePasswordResetToken) {
	137	+ $leftButtonText = $this->l10n->t('Set your password');
	138	+ } else {
	139	+ $leftButtonText = $this->l10n->t('Go to %s', [$this->themingDefaults->getName()]);
	140	+ }
	141	+ $emailTemplate->addBodyButtonGroup(
	142	+ $leftButtonText,
	143	+ $link,
	144	+ $this->l10n->t('Install Client'),
	145	+ 'https://nextcloud.com/install/#install-clients'
	146	+ );
	147	+ $emailTemplate->addFooter();
148	148
149		- return $emailTemplate;
150		- }
	149	+ return $emailTemplate;
	150	+ }
151	151
152		- /**
153		- * Sends a welcome mail to $user
154		- *
155		- * @param IUser $user
156		- * @param IEmailTemplate $emailTemplate
157		- * @throws \Exception If mail could not be sent
158		- */
159		- public function sendMail(IUser $user,
160		- IEMailTemplate $emailTemplate) {
161		- $message = $this->mailer->createMessage();
162		- $message->setTo([$user->getEMailAddress() => $user->getDisplayName()]);
163		- $message->setSubject($this->l10n->t('Your %s account was created', [$this->themingDefaults->getName()]));
164		- $message->setHtmlBody($emailTemplate->renderHtml());
165		- $message->setPlainBody($emailTemplate->renderText());
166		- $message->setFrom([$this->fromAddress => $this->themingDefaults->getName()]);
167		- $this->mailer->send($message);
168		- }
	152	+ /**
	153	+ * Sends a welcome mail to $user
	154	+ *
	155	+ * @param IUser $user
	156	+ * @param IEmailTemplate $emailTemplate
	157	+ * @throws \Exception If mail could not be sent
	158	+ */
	159	+ public function sendMail(IUser $user,
	160	+ IEMailTemplate $emailTemplate) {
	161	+ $message = $this->mailer->createMessage();
	162	+ $message->setTo([$user->getEMailAddress() => $user->getDisplayName()]);
	163	+ $message->setSubject($this->l10n->t('Your %s account was created', [$this->themingDefaults->getName()]));
	164	+ $message->setHtmlBody($emailTemplate->renderHtml());
	165	+ $message->setPlainBody($emailTemplate->renderText());
	166	+ $message->setFrom([$this->fromAddress => $this->themingDefaults->getName()]);
	167	+ $this->mailer->send($message);
	168	+ }
169	169	}

nextcloud / server

Pull Request — master (#6358)

Status

Category

Indentation +126 added lines, -126 removed lines patch added patch discarded remove patch