nextcloud / server

lib/private/DateTimeFormatter.php

Indentation +268 added lines, -268 removed lines

@@ -25,294 +25,294 @@
 namespace OC;
 
 class DateTimeFormatter implements \OCP\IDateTimeFormatter {
-	/** @var \DateTimeZone */
-	protected $defaultTimeZone;
+    /** @var \DateTimeZone */
+    protected $defaultTimeZone;
 
-	/** @var \OCP\IL10N */
-	protected $defaultL10N;
+    /** @var \OCP\IL10N */
+    protected $defaultL10N;
 
-	/**
-	 * Constructor
-	 *
-	 * @param \DateTimeZone $defaultTimeZone Set the timezone for the format
-	 * @param \OCP\IL10N $defaultL10N Set the language for the format
-	 */
-	public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
-		$this->defaultTimeZone = $defaultTimeZone;
-		$this->defaultL10N = $defaultL10N;
-	}
+    /**
+     * Constructor
+     *
+     * @param \DateTimeZone $defaultTimeZone Set the timezone for the format
+     * @param \OCP\IL10N $defaultL10N Set the language for the format
+     */
+    public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
+        $this->defaultTimeZone = $defaultTimeZone;
+        $this->defaultL10N = $defaultL10N;
+    }
 
-	/**
-	 * Get TimeZone to use
-	 *
-	 * @param \DateTimeZone $timeZone	The timezone to use
-	 * @return \DateTimeZone		The timezone to use, falling back to the current user's timezone
-	 */
-	protected function getTimeZone($timeZone = null) {
-		if ($timeZone === null) {
-			$timeZone = $this->defaultTimeZone;
-		}
+    /**
+     * Get TimeZone to use
+     *
+     * @param \DateTimeZone $timeZone	The timezone to use
+     * @return \DateTimeZone		The timezone to use, falling back to the current user's timezone
+     */
+    protected function getTimeZone($timeZone = null) {
+        if ($timeZone === null) {
+            $timeZone = $this->defaultTimeZone;
+        }
 
-		return $timeZone;
-	}
+        return $timeZone;
+    }
 
-	/**
-	 * Get \OCP\IL10N to use
-	 *
-	 * @param \OCP\IL10N $l	The locale to use
-	 * @return \OCP\IL10N		The locale to use, falling back to the current user's locale
-	 */
-	protected function getLocale($l = null) {
-		if ($l === null) {
-			$l = $this->defaultL10N;
-		}
+    /**
+     * Get \OCP\IL10N to use
+     *
+     * @param \OCP\IL10N $l	The locale to use
+     * @return \OCP\IL10N		The locale to use, falling back to the current user's locale
+     */
+    protected function getLocale($l = null) {
+        if ($l === null) {
+            $l = $this->defaultL10N;
+        }
 
-		return $l;
-	}
+        return $l;
+    }
 
-	/**
-	 * Generates a DateTime object with the given timestamp and TimeZone
-	 *
-	 * @param mixed $timestamp
-	 * @param \DateTimeZone $timeZone	The timezone to use
-	 * @return \DateTime
-	 */
-	protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) {
-		if ($timestamp === null) {
-			return new \DateTime('now', $timeZone);
-		} else if (!$timestamp instanceof \DateTime) {
-			$dateTime = new \DateTime('now', $timeZone);
-			$dateTime->setTimestamp($timestamp);
-			return $dateTime;
-		}
-		if ($timeZone) {
-			$timestamp->setTimezone($timeZone);
-		}
-		return $timestamp;
-	}
+    /**
+     * Generates a DateTime object with the given timestamp and TimeZone
+     *
+     * @param mixed $timestamp
+     * @param \DateTimeZone $timeZone	The timezone to use
+     * @return \DateTime
+     */
+    protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) {
+        if ($timestamp === null) {
+            return new \DateTime('now', $timeZone);
+        } else if (!$timestamp instanceof \DateTime) {
+            $dateTime = new \DateTime('now', $timeZone);
+            $dateTime->setTimestamp($timestamp);
+            return $dateTime;
+        }
+        if ($timeZone) {
+            $timestamp->setTimezone($timeZone);
+        }
+        return $timestamp;
+    }
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date string
-	 */
-	public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'date', $format, $timeZone, $l);
-	}
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date string
+     */
+    public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'date', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date string
-	 */
-	public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		if (substr($format, -1) !== '*' && substr($format, -1) !== '*') {
-			$format .= '^';
-		}
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date string
+     */
+    public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        if (substr($format, -1) !== '*' && substr($format, -1) !== '*') {
+            $format .= '^';
+        }
 
-		return $this->format($timestamp, 'date', $format, $timeZone, $l);
-	}
+        return $this->format($timestamp, 'date', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Gives the relative date of the timestamp
-	 * Only works for past dates
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				<  1 month	=> Today, Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date span
-	 */
-	public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timestamp = $this->getDateTime($timestamp);
-		$timestamp->setTime(0, 0, 0);
+    /**
+     * Gives the relative date of the timestamp
+     * Only works for past dates
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				<  1 month	=> Today, Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date span
+     */
+    public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timestamp = $this->getDateTime($timestamp);
+        $timestamp->setTime(0, 0, 0);
 
-		if ($baseTimestamp === null) {
-			$baseTimestamp = time();
-		}
-		$baseTimestamp = $this->getDateTime($baseTimestamp);
-		$baseTimestamp->setTime(0, 0, 0);
-		$dateInterval = $timestamp->diff($baseTimestamp);
+        if ($baseTimestamp === null) {
+            $baseTimestamp = time();
+        }
+        $baseTimestamp = $this->getDateTime($baseTimestamp);
+        $baseTimestamp->setTime(0, 0, 0);
+        $dateInterval = $timestamp->diff($baseTimestamp);
 
-		if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
-			return $l->t('today');
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->t('tomorrow');
-			} else {
-				return $l->t('yesterday');
-			}
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n day', 'in %n days', $dateInterval->d);
-			} else {
-				return $l->n('%n day ago', '%n days ago', $dateInterval->d);
-			}
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 1) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->t('next month');
-			} else {
-				return $l->t('last month');
-			}
-		} else if ($dateInterval->y == 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n month', 'in %n months', $dateInterval->m);
-			} else {
-				return $l->n('%n month ago', '%n months ago', $dateInterval->m);
-			}
-		} else if ($dateInterval->y == 1) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->t('next year');
-			} else {
-				return $l->t('last year');
-			}
-		}
-		if ($timestamp > $baseTimestamp) {
-			return $l->n('in %n year', 'in %n years', $dateInterval->y);
-		} else {
-			return $l->n('%n year ago', '%n years ago', $dateInterval->y);
-		}
-	}
+        if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
+            return $l->t('today');
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->t('tomorrow');
+            } else {
+                return $l->t('yesterday');
+            }
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n day', 'in %n days', $dateInterval->d);
+            } else {
+                return $l->n('%n day ago', '%n days ago', $dateInterval->d);
+            }
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 1) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->t('next month');
+            } else {
+                return $l->t('last month');
+            }
+        } else if ($dateInterval->y == 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n month', 'in %n months', $dateInterval->m);
+            } else {
+                return $l->n('%n month ago', '%n months ago', $dateInterval->m);
+            }
+        } else if ($dateInterval->y == 1) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->t('next year');
+            } else {
+                return $l->t('last year');
+            }
+        }
+        if ($timestamp > $baseTimestamp) {
+            return $l->n('in %n year', 'in %n years', $dateInterval->y);
+        } else {
+            return $l->n('%n year ago', '%n years ago', $dateInterval->y);
+        }
+    }
 
-	/**
-	 * Formats the time of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
-	 * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
-	 * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
-	 * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted time string
-	 */
-	public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'time', $format, $timeZone, $l);
-	}
+    /**
+     * Formats the time of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
+     * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
+     * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
+     * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted time string
+     */
+    public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'time', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Gives the relative past time of the timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				< 60 sec	=> seconds ago
-	 * 				<  1 hour	=> n minutes ago
-	 * 				<  1 day	=> n hours ago
-	 * 				<  1 month	=> Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted time span
-	 */
-	public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timestamp = $this->getDateTime($timestamp);
-		if ($baseTimestamp === null) {
-			$baseTimestamp = time();
-		}
-		$baseTimestamp = $this->getDateTime($baseTimestamp);
+    /**
+     * Gives the relative past time of the timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				< 60 sec	=> seconds ago
+     * 				<  1 hour	=> n minutes ago
+     * 				<  1 day	=> n hours ago
+     * 				<  1 month	=> Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted time span
+     */
+    public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timestamp = $this->getDateTime($timestamp);
+        if ($baseTimestamp === null) {
+            $baseTimestamp = time();
+        }
+        $baseTimestamp = $this->getDateTime($baseTimestamp);
 
-		$diff = $timestamp->diff($baseTimestamp);
-		if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
-			return $this->formatDateSpan($timestamp, $baseTimestamp, $l);
-		}
+        $diff = $timestamp->diff($baseTimestamp);
+        if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
+            return $this->formatDateSpan($timestamp, $baseTimestamp, $l);
+        }
 
-		if ($diff->h > 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n hour', 'in %n hours', $diff->h);
-			} else {
-				return $l->n('%n hour ago', '%n hours ago', $diff->h);
-			}
-		} else if ($diff->i > 0) {
-			if ($timestamp > $baseTimestamp) {
-				return $l->n('in %n minute', 'in %n minutes', $diff->i);
-			} else {
-				return $l->n('%n minute ago', '%n minutes ago', $diff->i);
-			}
-		}
-		if ($timestamp > $baseTimestamp) {
-			return $l->t('in a few seconds');
-		} else {
-			return $l->t('seconds ago');
-		}
-	}
+        if ($diff->h > 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n hour', 'in %n hours', $diff->h);
+            } else {
+                return $l->n('%n hour ago', '%n hours ago', $diff->h);
+            }
+        } else if ($diff->i > 0) {
+            if ($timestamp > $baseTimestamp) {
+                return $l->n('in %n minute', 'in %n minutes', $diff->i);
+            } else {
+                return $l->n('%n minute ago', '%n minutes ago', $diff->i);
+            }
+        }
+        if ($timestamp > $baseTimestamp) {
+            return $l->t('in a few seconds');
+        } else {
+            return $l->t('seconds ago');
+        }
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string		$formatDate		See formatDate() for description
-	 * @param string		$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date and time string
-	 */
-	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
-	}
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string		$formatDate		See formatDate() for description
+     * @param string		$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date and time string
+     */
+    public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$formatDate		See formatDate() for description
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date and time string
-	 */
-	public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') {
-			$formatDate .= '^';
-		}
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$formatDate		See formatDate() for description
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date and time string
+     */
+    public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') {
+            $formatDate .= '^';
+        }
 
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
-	}
+        return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string		$type		One of 'date', 'datetime' or 'time'
-	 * @param string		$format		Format string
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date and time string
-	 */
-	protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timeZone = $this->getTimeZone($timeZone);
-		$timestamp = $this->getDateTime($timestamp, $timeZone);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string		$type		One of 'date', 'datetime' or 'time'
+     * @param string		$format		Format string
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date and time string
+     */
+    protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timeZone = $this->getTimeZone($timeZone);
+        $timestamp = $this->getDateTime($timestamp, $timeZone);
 
-		return $l->l($type, $timestamp, [
-			'width' => $format,
-		]);
-	}
+        return $l->l($type, $timestamp, [
+            'width' => $format,
+        ]);
+    }
 }

lib/private/Hooks/EmitterTrait.php

Indentation +72 added lines, -72 removed lines

@@ -25,80 +25,80 @@
 
 trait EmitterTrait {
 
-	/**
-	 * @var callable[][] $listeners
-	 */
-	protected $listeners = [];
+    /**
+     * @var callable[][] $listeners
+     */
+    protected $listeners = [];
 
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param callable $callback
-	 */
-	public function listen($scope, $method, callable $callback) {
-		$eventName = $scope . '::' . $method;
-		if (!isset($this->listeners[$eventName])) {
-			$this->listeners[$eventName] = [];
-		}
-		if (array_search($callback, $this->listeners[$eventName], true) === false) {
-			$this->listeners[$eventName][] = $callback;
-		}
-	}
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param callable $callback
+     */
+    public function listen($scope, $method, callable $callback) {
+        $eventName = $scope . '::' . $method;
+        if (!isset($this->listeners[$eventName])) {
+            $this->listeners[$eventName] = [];
+        }
+        if (array_search($callback, $this->listeners[$eventName], true) === false) {
+            $this->listeners[$eventName][] = $callback;
+        }
+    }
 
-	/**
-	 * @param string $scope optional
-	 * @param string $method optional
-	 * @param callable $callback optional
-	 */
-	public function removeListener($scope = null, $method = null, callable $callback = null) {
-		$names = [];
-		$allNames = array_keys($this->listeners);
-		if ($scope and $method) {
-			$name = $scope . '::' . $method;
-			if (isset($this->listeners[$name])) {
-				$names[] = $name;
-			}
-		} elseif ($scope) {
-			foreach ($allNames as $name) {
-				$parts = explode('::', $name, 2);
-				if ($parts[0] == $scope) {
-					$names[] = $name;
-				}
-			}
-		} elseif ($method) {
-			foreach ($allNames as $name) {
-				$parts = explode('::', $name, 2);
-				if ($parts[1] == $method) {
-					$names[] = $name;
-				}
-			}
-		} else {
-			$names = $allNames;
-		}
+    /**
+     * @param string $scope optional
+     * @param string $method optional
+     * @param callable $callback optional
+     */
+    public function removeListener($scope = null, $method = null, callable $callback = null) {
+        $names = [];
+        $allNames = array_keys($this->listeners);
+        if ($scope and $method) {
+            $name = $scope . '::' . $method;
+            if (isset($this->listeners[$name])) {
+                $names[] = $name;
+            }
+        } elseif ($scope) {
+            foreach ($allNames as $name) {
+                $parts = explode('::', $name, 2);
+                if ($parts[0] == $scope) {
+                    $names[] = $name;
+                }
+            }
+        } elseif ($method) {
+            foreach ($allNames as $name) {
+                $parts = explode('::', $name, 2);
+                if ($parts[1] == $method) {
+                    $names[] = $name;
+                }
+            }
+        } else {
+            $names = $allNames;
+        }
 
-		foreach ($names as $name) {
-			if ($callback) {
-				$index = array_search($callback, $this->listeners[$name], true);
-				if ($index !== false) {
-					unset($this->listeners[$name][$index]);
-				}
-			} else {
-				$this->listeners[$name] = [];
-			}
-		}
-	}
+        foreach ($names as $name) {
+            if ($callback) {
+                $index = array_search($callback, $this->listeners[$name], true);
+                if ($index !== false) {
+                    unset($this->listeners[$name][$index]);
+                }
+            } else {
+                $this->listeners[$name] = [];
+            }
+        }
+    }
 
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments optional
-	 */
-	protected function emit($scope, $method, array $arguments = []) {
-		$eventName = $scope . '::' . $method;
-		if (isset($this->listeners[$eventName])) {
-			foreach ($this->listeners[$eventName] as $callback) {
-				call_user_func_array($callback, $arguments);
-			}
-		}
-	}
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments optional
+     */
+    protected function emit($scope, $method, array $arguments = []) {
+        $eventName = $scope . '::' . $method;
+        if (isset($this->listeners[$eventName])) {
+            foreach ($this->listeners[$eventName] as $callback) {
+                call_user_func_array($callback, $arguments);
+            }
+        }
+    }
 }

lib/private/Hooks/PublicEmitter.php

Indentation +10 added lines, -10 removed lines

@@ -29,14 +29,14 @@
  * @deprecated 18.0.0 use events and the \OCP\EventDispatcher\IEventDispatcher service
  */
 class PublicEmitter extends BasicEmitter {
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments optional
-	 *
-	 * @suppress PhanAccessMethodProtected
-	 */
-	public function emit($scope, $method, array $arguments = []) {
-		parent::emit($scope, $method, $arguments);
-	}
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments optional
+     *
+     * @suppress PhanAccessMethodProtected
+     */
+    public function emit($scope, $method, array $arguments = []) {
+        parent::emit($scope, $method, $arguments);
+    }
 }

lib/private/Memcache/ArrayCache.php

Indentation +117 added lines, -117 removed lines

@@ -27,133 +27,133 @@
 use OCP\IMemcache;
 
 class ArrayCache extends Cache implements IMemcache {
-	/** @var array Array with the cached data */
-	protected $cachedData = [];
+    /** @var array Array with the cached data */
+    protected $cachedData = [];
 
-	use CADTrait;
+    use CADTrait;
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function get($key) {
-		if ($this->hasKey($key)) {
-			return $this->cachedData[$key];
-		}
-		return null;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function get($key) {
+        if ($this->hasKey($key)) {
+            return $this->cachedData[$key];
+        }
+        return null;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function set($key, $value, $ttl = 0) {
-		$this->cachedData[$key] = $value;
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function set($key, $value, $ttl = 0) {
+        $this->cachedData[$key] = $value;
+        return true;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function hasKey($key) {
-		return isset($this->cachedData[$key]);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function hasKey($key) {
+        return isset($this->cachedData[$key]);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function remove($key) {
-		unset($this->cachedData[$key]);
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function remove($key) {
+        unset($this->cachedData[$key]);
+        return true;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function clear($prefix = '') {
-		if ($prefix === '') {
-			$this->cachedData = [];
-			return true;
-		}
+    /**
+     * {@inheritDoc}
+     */
+    public function clear($prefix = '') {
+        if ($prefix === '') {
+            $this->cachedData = [];
+            return true;
+        }
 
-		foreach ($this->cachedData as $key => $value) {
-			if (strpos($key, $prefix) === 0) {
-				$this->remove($key);
-			}
-		}
-		return true;
-	}
+        foreach ($this->cachedData as $key => $value) {
+            if (strpos($key, $prefix) === 0) {
+                $this->remove($key);
+            }
+        }
+        return true;
+    }
 
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		// since this cache is not shared race conditions aren't an issue
-		if ($this->hasKey($key)) {
-			return false;
-		} else {
-			return $this->set($key, $value, $ttl);
-		}
-	}
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        // since this cache is not shared race conditions aren't an issue
+        if ($this->hasKey($key)) {
+            return false;
+        } else {
+            return $this->set($key, $value, $ttl);
+        }
+    }
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$oldValue = $this->get($key);
-		if (is_int($oldValue)) {
-			$this->set($key, $oldValue + $step);
-			return $oldValue + $step;
-		} else {
-			$success = $this->add($key, $step);
-			return $success ? $step : false;
-		}
-	}
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $oldValue = $this->get($key);
+        if (is_int($oldValue)) {
+            $this->set($key, $oldValue + $step);
+            return $oldValue + $step;
+        } else {
+            $success = $this->add($key, $step);
+            return $success ? $step : false;
+        }
+    }
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$oldValue = $this->get($key);
-		if (is_int($oldValue)) {
-			$this->set($key, $oldValue - $step);
-			return $oldValue - $step;
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $oldValue = $this->get($key);
+        if (is_int($oldValue)) {
+            $this->set($key, $oldValue - $step);
+            return $oldValue - $step;
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 */
-	public function cas($key, $old, $new) {
-		if ($this->get($key) === $old) {
-			return $this->set($key, $new);
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     */
+    public function cas($key, $old, $new) {
+        if ($this->get($key) === $old) {
+            return $this->set($key, $new);
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	static public function isAvailable() {
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    static public function isAvailable() {
+        return true;
+    }
 }

lib/private/Memcache/Memcached.php

Indentation +189 added lines, -189 removed lines

@@ -35,193 +35,193 @@
 use OCP\IMemcache;
 
 class Memcached extends Cache implements IMemcache {
-	use CASTrait;
-
-	/**
-	 * @var \Memcached $cache
-	 */
-	private static $cache = null;
-
-	use CADTrait;
-
-	public function __construct($prefix = '') {
-		parent::__construct($prefix);
-		if (is_null(self::$cache)) {
-			self::$cache = new \Memcached();
-
-			$defaultOptions = [
-				\Memcached::OPT_CONNECT_TIMEOUT => 50,
-				\Memcached::OPT_RETRY_TIMEOUT =>   50,
-				\Memcached::OPT_SEND_TIMEOUT =>    50,
-				\Memcached::OPT_RECV_TIMEOUT =>    50,
-				\Memcached::OPT_POLL_TIMEOUT =>    50,
-
-				// Enable compression
-				\Memcached::OPT_COMPRESSION =>          true,
-
-				// Turn on consistent hashing
-				\Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
-
-				// Enable Binary Protocol
-				//\Memcached::OPT_BINARY_PROTOCOL =>      true,
-			];
-			// by default enable igbinary serializer if available
-			if (\Memcached::HAVE_IGBINARY) {
-				$defaultOptions[\Memcached::OPT_SERIALIZER] =
-					\Memcached::SERIALIZER_IGBINARY;
-			}
-			$options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
-			if (is_array($options)) {
-				$options = $options + $defaultOptions;
-				self::$cache->setOptions($options);
-			} else {
-				throw new HintException("Expected 'memcached_options' config to be an array, got $options");
-			}
-
-			$servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
-			if (!$servers) {
-				$server = \OC::$server->getSystemConfig()->getValue('memcached_server');
-				if ($server) {
-					$servers = [$server];
-				} else {
-					$servers = [['localhost', 11211]];
-				}
-			}
-			self::$cache->addServers($servers);
-		}
-	}
-
-	/**
-	 * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
-	 */
-	protected function getNameSpace() {
-		return $this->prefix;
-	}
-
-	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
-		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
-			return null;
-		} else {
-			return $result;
-		}
-	}
-
-	public function set($key, $value, $ttl = 0) {
-		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
-		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
-		}
-		if ($result !== true) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
-		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
-	}
-
-	public function remove($key) {
-		$result= self::$cache->delete($this->getNameSpace() . $key);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function clear($prefix = '') {
-		$prefix = $this->getNameSpace() . $prefix;
-		$allKeys = self::$cache->getAllKeys();
-		if ($allKeys === false) {
-			// newer Memcached doesn't like getAllKeys(), flush everything
-			self::$cache->flush();
-			return true;
-		}
-		$keys = [];
-		$prefixLength = strlen($prefix);
-		foreach ($allKeys as $key) {
-			if (substr($key, 0, $prefixLength) === $prefix) {
-				$keys[] = $key;
-			}
-		}
-		if (method_exists(self::$cache, 'deleteMulti')) {
-			self::$cache->deleteMulti($keys);
-		} else {
-			foreach ($keys as $key) {
-				self::$cache->delete($key);
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	static public function isAvailable() {
-		return extension_loaded('memcached');
-	}
-
-	/**
-	 * @throws \Exception
-	 */
-	private function verifyReturnCode() {
-		$code = self::$cache->getResultCode();
-		if ($code === \Memcached::RES_SUCCESS) {
-			return;
-		}
-		$message = self::$cache->getResultMessage();
-		throw new \Exception("Error $code interacting with memcached : $message");
-	}
+    use CASTrait;
+
+    /**
+     * @var \Memcached $cache
+     */
+    private static $cache = null;
+
+    use CADTrait;
+
+    public function __construct($prefix = '') {
+        parent::__construct($prefix);
+        if (is_null(self::$cache)) {
+            self::$cache = new \Memcached();
+
+            $defaultOptions = [
+                \Memcached::OPT_CONNECT_TIMEOUT => 50,
+                \Memcached::OPT_RETRY_TIMEOUT =>   50,
+                \Memcached::OPT_SEND_TIMEOUT =>    50,
+                \Memcached::OPT_RECV_TIMEOUT =>    50,
+                \Memcached::OPT_POLL_TIMEOUT =>    50,
+
+                // Enable compression
+                \Memcached::OPT_COMPRESSION =>          true,
+
+                // Turn on consistent hashing
+                \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
+
+                // Enable Binary Protocol
+                //\Memcached::OPT_BINARY_PROTOCOL =>      true,
+            ];
+            // by default enable igbinary serializer if available
+            if (\Memcached::HAVE_IGBINARY) {
+                $defaultOptions[\Memcached::OPT_SERIALIZER] =
+                    \Memcached::SERIALIZER_IGBINARY;
+            }
+            $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
+            if (is_array($options)) {
+                $options = $options + $defaultOptions;
+                self::$cache->setOptions($options);
+            } else {
+                throw new HintException("Expected 'memcached_options' config to be an array, got $options");
+            }
+
+            $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
+            if (!$servers) {
+                $server = \OC::$server->getSystemConfig()->getValue('memcached_server');
+                if ($server) {
+                    $servers = [$server];
+                } else {
+                    $servers = [['localhost', 11211]];
+                }
+            }
+            self::$cache->addServers($servers);
+        }
+    }
+
+    /**
+     * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
+     */
+    protected function getNameSpace() {
+        return $this->prefix;
+    }
+
+    public function get($key) {
+        $result = self::$cache->get($this->getNameSpace() . $key);
+        if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
+            return null;
+        } else {
+            return $result;
+        }
+    }
+
+    public function set($key, $value, $ttl = 0) {
+        if ($ttl > 0) {
+            $result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+        } else {
+            $result = self::$cache->set($this->getNameSpace() . $key, $value);
+        }
+        if ($result !== true) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function hasKey($key) {
+        self::$cache->get($this->getNameSpace() . $key);
+        return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
+    }
+
+    public function remove($key) {
+        $result= self::$cache->delete($this->getNameSpace() . $key);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function clear($prefix = '') {
+        $prefix = $this->getNameSpace() . $prefix;
+        $allKeys = self::$cache->getAllKeys();
+        if ($allKeys === false) {
+            // newer Memcached doesn't like getAllKeys(), flush everything
+            self::$cache->flush();
+            return true;
+        }
+        $keys = [];
+        $prefixLength = strlen($prefix);
+        foreach ($allKeys as $key) {
+            if (substr($key, 0, $prefixLength) === $prefix) {
+                $keys[] = $key;
+            }
+        }
+        if (method_exists(self::$cache, 'deleteMulti')) {
+            self::$cache->deleteMulti($keys);
+        } else {
+            foreach ($keys as $key) {
+                self::$cache->delete($key);
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     * @throws \Exception
+     */
+    public function add($key, $value, $ttl = 0) {
+        $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        $result = self::$cache->increment($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $result = self::$cache->decrement($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    static public function isAvailable() {
+        return extension_loaded('memcached');
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function verifyReturnCode() {
+        $code = self::$cache->getResultCode();
+        if ($code === \Memcached::RES_SUCCESS) {
+            return;
+        }
+        $message = self::$cache->getResultMessage();
+        throw new \Exception("Error $code interacting with memcached : $message");
+    }
 }

lib/private/Activity/Manager.php

Indentation +344 added lines, -344 removed lines

@@ -41,349 +41,349 @@
 use OCP\RichObjectStrings\IValidator;
 
 class Manager implements IManager {
-	/** @var IRequest */
-	protected $request;
-
-	/** @var IUserSession */
-	protected $session;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IValidator */
-	protected $validator;
-
-	/** @var string */
-	protected $formattingObjectType;
-
-	/** @var int */
-	protected $formattingObjectId;
-
-	/** @var bool */
-	protected $requirePNG = false;
-
-	/** @var string */
-	protected $currentUserId;
-
-	public function __construct(IRequest $request,
-								IUserSession $session,
-								IConfig $config,
-								IValidator $validator) {
-		$this->request = $request;
-		$this->session = $session;
-		$this->config = $config;
-		$this->validator = $validator;
-	}
-
-	/** @var \Closure[] */
-	private $consumersClosures = [];
-
-	/** @var IConsumer[] */
-	private $consumers = [];
-
-	/**
-	 * @return \OCP\Activity\IConsumer[]
-	 */
-	protected function getConsumers(): array {
-		if (!empty($this->consumers)) {
-			return $this->consumers;
-		}
-
-		$this->consumers = [];
-		foreach($this->consumersClosures as $consumer) {
-			$c = $consumer();
-			if ($c instanceof IConsumer) {
-				$this->consumers[] = $c;
-			} else {
-				throw new \InvalidArgumentException('The given consumer does not implement the \OCP\Activity\IConsumer interface');
-			}
-		}
-
-		return $this->consumers;
-	}
-
-	/**
-	 * Generates a new IEvent object
-	 *
-	 * Make sure to call at least the following methods before sending it to the
-	 * app with via the publish() method:
-	 *  - setApp()
-	 *  - setType()
-	 *  - setAffectedUser()
-	 *  - setSubject()
-	 *
-	 * @return IEvent
-	 */
-	public function generateEvent(): IEvent {
-		return new Event($this->validator);
-	}
-
-	/**
-	 * Publish an event to the activity consumers
-	 *
-	 * Make sure to call at least the following methods before sending an Event:
-	 *  - setApp()
-	 *  - setType()
-	 *  - setAffectedUser()
-	 *  - setSubject()
-	 *
-	 * @param IEvent $event
-	 * @throws \BadMethodCallException if required values have not been set
-	 */
-	public function publish(IEvent $event): void {
-		if ($event->getAuthor() === '') {
-			if ($this->session->getUser() instanceof IUser) {
-				$event->setAuthor($this->session->getUser()->getUID());
-			}
-		}
-
-		if (!$event->getTimestamp()) {
-			$event->setTimestamp(time());
-		}
-
-		if (!$event->isValid()) {
-			throw new \BadMethodCallException('The given event is invalid');
-		}
-
-		foreach ($this->getConsumers() as $c) {
-			$c->receive($event);
-		}
-	}
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * activity consumers are actually requested
-	 *
-	 * $callable has to return an instance of OCA\Activity\IConsumer
-	 *
-	 * @param \Closure $callable
-	 */
-	public function registerConsumer(\Closure $callable): void {
-		$this->consumersClosures[] = $callable;
-		$this->consumers = [];
-	}
-
-	/** @var string[] */
-	protected $filterClasses = [];
-
-	/** @var IFilter[] */
-	protected $filters = [];
-
-	/**
-	 * @param string $filter Class must implement OCA\Activity\IFilter
-	 * @return void
-	 */
-	public function registerFilter(string $filter): void {
-		$this->filterClasses[$filter] = false;
-	}
-
-	/**
-	 * @return IFilter[]
-	 * @throws \InvalidArgumentException
-	 */
-	public function getFilters(): array {
-		foreach ($this->filterClasses as $class => $false) {
-			/** @var IFilter $filter */
-			$filter = \OC::$server->query($class);
-
-			if (!$filter instanceof IFilter) {
-				throw new \InvalidArgumentException('Invalid activity filter registered');
-			}
-
-			$this->filters[$filter->getIdentifier()] = $filter;
-
-			unset($this->filterClasses[$class]);
-		}
-		return $this->filters;
-	}
-
-	/**
-	 * @param string $id
-	 * @return IFilter
-	 * @throws \InvalidArgumentException when the filter was not found
-	 * @since 11.0.0
-	 */
-	public function getFilterById(string $id): IFilter {
-		$filters = $this->getFilters();
-
-		if (isset($filters[$id])) {
-			return $filters[$id];
-		}
-
-		throw new \InvalidArgumentException('Requested filter does not exist');
-	}
-
-	/** @var string[] */
-	protected $providerClasses = [];
-
-	/** @var IProvider[] */
-	protected $providers = [];
-
-	/**
-	 * @param string $provider Class must implement OCA\Activity\IProvider
-	 * @return void
-	 */
-	public function registerProvider(string $provider): void {
-		$this->providerClasses[$provider] = false;
-	}
-
-	/**
-	 * @return IProvider[]
-	 * @throws \InvalidArgumentException
-	 */
-	public function getProviders(): array {
-		foreach ($this->providerClasses as $class => $false) {
-			/** @var IProvider $provider */
-			$provider = \OC::$server->query($class);
-
-			if (!$provider instanceof IProvider) {
-				throw new \InvalidArgumentException('Invalid activity provider registered');
-			}
-
-			$this->providers[] = $provider;
-
-			unset($this->providerClasses[$class]);
-		}
-		return $this->providers;
-	}
-
-	/** @var string[] */
-	protected $settingsClasses = [];
-
-	/** @var ISetting[] */
-	protected $settings = [];
-
-	/**
-	 * @param string $setting Class must implement OCA\Activity\ISetting
-	 * @return void
-	 */
-	public function registerSetting(string $setting): void {
-		$this->settingsClasses[$setting] = false;
-	}
-
-	/**
-	 * @return ISetting[]
-	 * @throws \InvalidArgumentException
-	 */
-	public function getSettings(): array {
-		foreach ($this->settingsClasses as $class => $false) {
-			/** @var ISetting $setting */
-			$setting = \OC::$server->query($class);
-
-			if (!$setting instanceof ISetting) {
-				throw new \InvalidArgumentException('Invalid activity filter registered');
-			}
-
-			$this->settings[$setting->getIdentifier()] = $setting;
-
-			unset($this->settingsClasses[$class]);
-		}
-		return $this->settings;
-	}
-
-	/**
-	 * @param string $id
-	 * @return ISetting
-	 * @throws \InvalidArgumentException when the setting was not found
-	 * @since 11.0.0
-	 */
-	public function getSettingById(string $id): ISetting {
-		$settings = $this->getSettings();
-
-		if (isset($settings[$id])) {
-			return $settings[$id];
-		}
-
-		throw new \InvalidArgumentException('Requested setting does not exist');
-	}
-
-
-	/**
-	 * @param string $type
-	 * @param int $id
-	 */
-	public function setFormattingObject(string $type, int $id): void {
-		$this->formattingObjectType = $type;
-		$this->formattingObjectId = $id;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isFormattingFilteredObject(): bool {
-		return $this->formattingObjectType !== null && $this->formattingObjectId !== null
-			&& $this->formattingObjectType === $this->request->getParam('object_type')
-			&& $this->formattingObjectId === (int) $this->request->getParam('object_id');
-	}
-
-	/**
-	 * @param bool $status Set to true, when parsing events should not use SVG icons
-	 */
-	public function setRequirePNG(bool $status): void {
-		$this->requirePNG = $status;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function getRequirePNG(): bool {
-		return $this->requirePNG;
-	}
-
-	/**
-	 * Set the user we need to use
-	 *
-	 * @param string|null $currentUserId
-	 * @throws \UnexpectedValueException If the user is invalid
-	 */
-	public function setCurrentUserId(string $currentUserId = null): void {
-		if (!is_string($currentUserId) && $currentUserId !== null) {
-			throw new \UnexpectedValueException('The given current user is invalid');
-		}
-		$this->currentUserId = $currentUserId;
-	}
-
-	/**
-	 * Get the user we need to use
-	 *
-	 * Either the user is logged in, or we try to get it from the token
-	 *
-	 * @return string
-	 * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
-	 */
-	public function getCurrentUserId(): string {
-		if ($this->currentUserId !== null) {
-			return $this->currentUserId;
-		}
-
-		if (!$this->session->isLoggedIn()) {
-			return $this->getUserFromToken();
-		}
-
-		return $this->session->getUser()->getUID();
-	}
-
-	/**
-	 * Get the user for the token
-	 *
-	 * @return string
-	 * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
-	 */
-	protected function getUserFromToken(): string {
-		$token = (string) $this->request->getParam('token', '');
-		if (strlen($token) !== 30) {
-			throw new \UnexpectedValueException('The token is invalid');
-		}
-
-		$users = $this->config->getUsersForUserValue('activity', 'rsstoken', $token);
-
-		if (count($users) !== 1) {
-			// No unique user found
-			throw new \UnexpectedValueException('The token is invalid');
-		}
-
-		// Token found login as that user
-		return array_shift($users);
-	}
+    /** @var IRequest */
+    protected $request;
+
+    /** @var IUserSession */
+    protected $session;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IValidator */
+    protected $validator;
+
+    /** @var string */
+    protected $formattingObjectType;
+
+    /** @var int */
+    protected $formattingObjectId;
+
+    /** @var bool */
+    protected $requirePNG = false;
+
+    /** @var string */
+    protected $currentUserId;
+
+    public function __construct(IRequest $request,
+                                IUserSession $session,
+                                IConfig $config,
+                                IValidator $validator) {
+        $this->request = $request;
+        $this->session = $session;
+        $this->config = $config;
+        $this->validator = $validator;
+    }
+
+    /** @var \Closure[] */
+    private $consumersClosures = [];
+
+    /** @var IConsumer[] */
+    private $consumers = [];
+
+    /**
+     * @return \OCP\Activity\IConsumer[]
+     */
+    protected function getConsumers(): array {
+        if (!empty($this->consumers)) {
+            return $this->consumers;
+        }
+
+        $this->consumers = [];
+        foreach($this->consumersClosures as $consumer) {
+            $c = $consumer();
+            if ($c instanceof IConsumer) {
+                $this->consumers[] = $c;
+            } else {
+                throw new \InvalidArgumentException('The given consumer does not implement the \OCP\Activity\IConsumer interface');
+            }
+        }
+
+        return $this->consumers;
+    }
+
+    /**
+     * Generates a new IEvent object
+     *
+     * Make sure to call at least the following methods before sending it to the
+     * app with via the publish() method:
+     *  - setApp()
+     *  - setType()
+     *  - setAffectedUser()
+     *  - setSubject()
+     *
+     * @return IEvent
+     */
+    public function generateEvent(): IEvent {
+        return new Event($this->validator);
+    }
+
+    /**
+     * Publish an event to the activity consumers
+     *
+     * Make sure to call at least the following methods before sending an Event:
+     *  - setApp()
+     *  - setType()
+     *  - setAffectedUser()
+     *  - setSubject()
+     *
+     * @param IEvent $event
+     * @throws \BadMethodCallException if required values have not been set
+     */
+    public function publish(IEvent $event): void {
+        if ($event->getAuthor() === '') {
+            if ($this->session->getUser() instanceof IUser) {
+                $event->setAuthor($this->session->getUser()->getUID());
+            }
+        }
+
+        if (!$event->getTimestamp()) {
+            $event->setTimestamp(time());
+        }
+
+        if (!$event->isValid()) {
+            throw new \BadMethodCallException('The given event is invalid');
+        }
+
+        foreach ($this->getConsumers() as $c) {
+            $c->receive($event);
+        }
+    }
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * activity consumers are actually requested
+     *
+     * $callable has to return an instance of OCA\Activity\IConsumer
+     *
+     * @param \Closure $callable
+     */
+    public function registerConsumer(\Closure $callable): void {
+        $this->consumersClosures[] = $callable;
+        $this->consumers = [];
+    }
+
+    /** @var string[] */
+    protected $filterClasses = [];
+
+    /** @var IFilter[] */
+    protected $filters = [];
+
+    /**
+     * @param string $filter Class must implement OCA\Activity\IFilter
+     * @return void
+     */
+    public function registerFilter(string $filter): void {
+        $this->filterClasses[$filter] = false;
+    }
+
+    /**
+     * @return IFilter[]
+     * @throws \InvalidArgumentException
+     */
+    public function getFilters(): array {
+        foreach ($this->filterClasses as $class => $false) {
+            /** @var IFilter $filter */
+            $filter = \OC::$server->query($class);
+
+            if (!$filter instanceof IFilter) {
+                throw new \InvalidArgumentException('Invalid activity filter registered');
+            }
+
+            $this->filters[$filter->getIdentifier()] = $filter;
+
+            unset($this->filterClasses[$class]);
+        }
+        return $this->filters;
+    }
+
+    /**
+     * @param string $id
+     * @return IFilter
+     * @throws \InvalidArgumentException when the filter was not found
+     * @since 11.0.0
+     */
+    public function getFilterById(string $id): IFilter {
+        $filters = $this->getFilters();
+
+        if (isset($filters[$id])) {
+            return $filters[$id];
+        }
+
+        throw new \InvalidArgumentException('Requested filter does not exist');
+    }
+
+    /** @var string[] */
+    protected $providerClasses = [];
+
+    /** @var IProvider[] */
+    protected $providers = [];
+
+    /**
+     * @param string $provider Class must implement OCA\Activity\IProvider
+     * @return void
+     */
+    public function registerProvider(string $provider): void {
+        $this->providerClasses[$provider] = false;
+    }
+
+    /**
+     * @return IProvider[]
+     * @throws \InvalidArgumentException
+     */
+    public function getProviders(): array {
+        foreach ($this->providerClasses as $class => $false) {
+            /** @var IProvider $provider */
+            $provider = \OC::$server->query($class);
+
+            if (!$provider instanceof IProvider) {
+                throw new \InvalidArgumentException('Invalid activity provider registered');
+            }
+
+            $this->providers[] = $provider;
+
+            unset($this->providerClasses[$class]);
+        }
+        return $this->providers;
+    }
+
+    /** @var string[] */
+    protected $settingsClasses = [];
+
+    /** @var ISetting[] */
+    protected $settings = [];
+
+    /**
+     * @param string $setting Class must implement OCA\Activity\ISetting
+     * @return void
+     */
+    public function registerSetting(string $setting): void {
+        $this->settingsClasses[$setting] = false;
+    }
+
+    /**
+     * @return ISetting[]
+     * @throws \InvalidArgumentException
+     */
+    public function getSettings(): array {
+        foreach ($this->settingsClasses as $class => $false) {
+            /** @var ISetting $setting */
+            $setting = \OC::$server->query($class);
+
+            if (!$setting instanceof ISetting) {
+                throw new \InvalidArgumentException('Invalid activity filter registered');
+            }
+
+            $this->settings[$setting->getIdentifier()] = $setting;
+
+            unset($this->settingsClasses[$class]);
+        }
+        return $this->settings;
+    }
+
+    /**
+     * @param string $id
+     * @return ISetting
+     * @throws \InvalidArgumentException when the setting was not found
+     * @since 11.0.0
+     */
+    public function getSettingById(string $id): ISetting {
+        $settings = $this->getSettings();
+
+        if (isset($settings[$id])) {
+            return $settings[$id];
+        }
+
+        throw new \InvalidArgumentException('Requested setting does not exist');
+    }
+
+
+    /**
+     * @param string $type
+     * @param int $id
+     */
+    public function setFormattingObject(string $type, int $id): void {
+        $this->formattingObjectType = $type;
+        $this->formattingObjectId = $id;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isFormattingFilteredObject(): bool {
+        return $this->formattingObjectType !== null && $this->formattingObjectId !== null
+            && $this->formattingObjectType === $this->request->getParam('object_type')
+            && $this->formattingObjectId === (int) $this->request->getParam('object_id');
+    }
+
+    /**
+     * @param bool $status Set to true, when parsing events should not use SVG icons
+     */
+    public function setRequirePNG(bool $status): void {
+        $this->requirePNG = $status;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getRequirePNG(): bool {
+        return $this->requirePNG;
+    }
+
+    /**
+     * Set the user we need to use
+     *
+     * @param string|null $currentUserId
+     * @throws \UnexpectedValueException If the user is invalid
+     */
+    public function setCurrentUserId(string $currentUserId = null): void {
+        if (!is_string($currentUserId) && $currentUserId !== null) {
+            throw new \UnexpectedValueException('The given current user is invalid');
+        }
+        $this->currentUserId = $currentUserId;
+    }
+
+    /**
+     * Get the user we need to use
+     *
+     * Either the user is logged in, or we try to get it from the token
+     *
+     * @return string
+     * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
+     */
+    public function getCurrentUserId(): string {
+        if ($this->currentUserId !== null) {
+            return $this->currentUserId;
+        }
+
+        if (!$this->session->isLoggedIn()) {
+            return $this->getUserFromToken();
+        }
+
+        return $this->session->getUser()->getUID();
+    }
+
+    /**
+     * Get the user for the token
+     *
+     * @return string
+     * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
+     */
+    protected function getUserFromToken(): string {
+        $token = (string) $this->request->getParam('token', '');
+        if (strlen($token) !== 30) {
+            throw new \UnexpectedValueException('The token is invalid');
+        }
+
+        $users = $this->config->getUsersForUserValue('activity', 'rsstoken', $token);
+
+        if (count($users) !== 1) {
+            // No unique user found
+            throw new \UnexpectedValueException('The token is invalid');
+        }
+
+        // Token found login as that user
+        return array_shift($users);
+    }
 
 }

lib/private/Search/Provider/File.php

Indentation +40 added lines, -40 removed lines

@@ -33,45 +33,45 @@
  */
 class File extends \OCP\Search\Provider {
 
-	/**
-	 * Search for files and folders matching the given query
-	 * @param string $query
-	 * @return \OCP\Search\Result
-	 */
-	public function search($query) {
-		$files = Filesystem::search($query);
-		$results = [];
-		// edit results
-		foreach ($files as $fileData) {
-			// skip versions
-			if (strpos($fileData['path'], '_versions') === 0) {
-				continue;
-			}
-			// skip top-level folder
-			if ($fileData['name'] === 'files' && $fileData['parent'] === -1) {
-				continue;
-			}
-			// create audio result
-			if($fileData['mimepart'] === 'audio'){
-				$result = new \OC\Search\Result\Audio($fileData);
-			}
-			// create image result
-			elseif($fileData['mimepart'] === 'image'){
-				$result = new \OC\Search\Result\Image($fileData);
-			}
-			// create folder result
-			elseif($fileData['mimetype'] === 'httpd/unix-directory'){
-				$result = new \OC\Search\Result\Folder($fileData);
-			}
-			// or create file result
-			else{
-				$result = new \OC\Search\Result\File($fileData);
-			}
-			// add to results
-			$results[] = $result;
-		}
-		// return
-		return $results;
-	}
+    /**
+     * Search for files and folders matching the given query
+     * @param string $query
+     * @return \OCP\Search\Result
+     */
+    public function search($query) {
+        $files = Filesystem::search($query);
+        $results = [];
+        // edit results
+        foreach ($files as $fileData) {
+            // skip versions
+            if (strpos($fileData['path'], '_versions') === 0) {
+                continue;
+            }
+            // skip top-level folder
+            if ($fileData['name'] === 'files' && $fileData['parent'] === -1) {
+                continue;
+            }
+            // create audio result
+            if($fileData['mimepart'] === 'audio'){
+                $result = new \OC\Search\Result\Audio($fileData);
+            }
+            // create image result
+            elseif($fileData['mimepart'] === 'image'){
+                $result = new \OC\Search\Result\Image($fileData);
+            }
+            // create folder result
+            elseif($fileData['mimetype'] === 'httpd/unix-directory'){
+                $result = new \OC\Search\Result\Folder($fileData);
+            }
+            // or create file result
+            else{
+                $result = new \OC\Search\Result\File($fileData);
+            }
+            // add to results
+            $results[] = $result;
+        }
+        // return
+        return $results;
+    }
 	
 }

lib/private/Encryption/DecryptAll.php

Indentation +260 added lines, -260 removed lines

@@ -37,265 +37,265 @@
 
 class DecryptAll {
 
-	/** @var  OutputInterface */
-	protected $output;
-
-	/** @var  InputInterface */
-	protected $input;
-
-	/** @var  Manager */
-	protected $encryptionManager;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var View */
-	protected $rootView;
-
-	/** @var  array files which couldn't be decrypted */
-	protected $failed;
-
-	/**
-	 * @param Manager $encryptionManager
-	 * @param IUserManager $userManager
-	 * @param View $rootView
-	 */
-	public function __construct(
-		Manager $encryptionManager,
-		IUserManager $userManager,
-		View $rootView
-	) {
-		$this->encryptionManager = $encryptionManager;
-		$this->userManager = $userManager;
-		$this->rootView = $rootView;
-		$this->failed = [];
-	}
-
-	/**
-	 * start to decrypt all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 * @param string $user which users data folder should be decrypted, default = all users
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public function decryptAll(InputInterface $input, OutputInterface $output, $user = '') {
-
-		$this->input = $input;
-		$this->output = $output;
-
-		if ($user !== '' && $this->userManager->userExists($user) === false) {
-			$this->output->writeln('User "' . $user . '" does not exist. Please check the username and try again');
-			return false;
-		}
-
-		$this->output->writeln('prepare encryption modules...');
-		if ($this->prepareEncryptionModules($user) === false) {
-			return false;
-		}
-		$this->output->writeln(' done.');
-
-		$this->decryptAllUsersFiles($user);
-
-		if (empty($this->failed)) {
-			$this->output->writeln('all files could be decrypted successfully!');
-		} else {
-			$this->output->writeln('Files for following users couldn\'t be decrypted, ');
-			$this->output->writeln('maybe the user is not set up in a way that supports this operation: ');
-			foreach ($this->failed as $uid => $paths) {
-				$this->output->writeln('    ' . $uid);
-				foreach ($paths as $path) {
-					$this->output->writeln('        ' . $path);
-				}
-			}
-			$this->output->writeln('');
-		}
-
-		return true;
-	}
-
-	/**
-	 * prepare encryption modules to perform the decrypt all function
-	 *
-	 * @param $user
-	 * @return bool
-	 */
-	protected function prepareEncryptionModules($user) {
-		// prepare all encryption modules for decrypt all
-		$encryptionModules = $this->encryptionManager->getEncryptionModules();
-		foreach ($encryptionModules as $moduleDesc) {
-			/** @var IEncryptionModule $module */
-			$module = call_user_func($moduleDesc['callback']);
-			$this->output->writeln('');
-			$this->output->writeln('Prepare "' . $module->getDisplayName() . '"');
-			$this->output->writeln('');
-			if ($module->prepareDecryptAll($this->input, $this->output, $user) === false) {
-				$this->output->writeln('Module "' . $moduleDesc['displayName'] . '" does not support the functionality to decrypt all files again or the initialization of the module failed!');
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * iterate over all user and encrypt their files
-	 *
-	 * @param string $user which users files should be decrypted, default = all users
-	 */
-	protected function decryptAllUsersFiles($user = '') {
-
-		$this->output->writeln("\n");
-
-		$userList = [];
-		if ($user === '') {
-
-			$fetchUsersProgress = new ProgressBar($this->output);
-			$fetchUsersProgress->setFormat(" %message% \n [%bar%]");
-			$fetchUsersProgress->start();
-			$fetchUsersProgress->setMessage("Fetch list of users...");
-			$fetchUsersProgress->advance();
-
-			foreach ($this->userManager->getBackends() as $backend) {
-				$limit = 500;
-				$offset = 0;
-				do {
-					$users = $backend->getUsers('', $limit, $offset);
-					foreach ($users as $user) {
-						$userList[] = $user;
-					}
-					$offset += $limit;
-					$fetchUsersProgress->advance();
-				} while (count($users) >= $limit);
-				$fetchUsersProgress->setMessage("Fetch list of users... finished");
-				$fetchUsersProgress->finish();
-			}
-		} else {
-			$userList[] = $user;
-		}
-
-		$this->output->writeln("\n\n");
-
-		$progress = new ProgressBar($this->output);
-		$progress->setFormat(" %message% \n [%bar%]");
-		$progress->start();
-		$progress->setMessage("starting to decrypt files...");
-		$progress->advance();
-
-		$numberOfUsers = count($userList);
-		$userNo = 1;
-		foreach ($userList as $uid) {
-			$userCount = "$uid ($userNo of $numberOfUsers)";
-			$this->decryptUsersFiles($uid, $progress, $userCount);
-			$userNo++;
-		}
-
-		$progress->setMessage("starting to decrypt files... finished");
-		$progress->finish();
-
-		$this->output->writeln("\n\n");
-
-	}
-
-	/**
-	 * encrypt files from the given user
-	 *
-	 * @param string $uid
-	 * @param ProgressBar $progress
-	 * @param string $userCount
-	 */
-	protected function decryptUsersFiles($uid, ProgressBar $progress, $userCount) {
-
-		$this->setupUserFS($uid);
-		$directories = [];
-		$directories[] = '/' . $uid . '/files';
-
-		while ($root = array_pop($directories)) {
-			$content = $this->rootView->getDirectoryContent($root);
-			foreach ($content as $file) {
-				// only decrypt files owned by the user
-				if($file->getStorage()->instanceOfStorage('OCA\Files_Sharing\SharedStorage')) {
-					continue;
-				}
-				$path = $root . '/' . $file['name'];
-				if ($this->rootView->is_dir($path)) {
-					$directories[] = $path;
-					continue;
-				} else {
-					try {
-						$progress->setMessage("decrypt files for user $userCount: $path");
-						$progress->advance();
-						if ($file->isEncrypted() === false) {
-							$progress->setMessage("decrypt files for user $userCount: $path (already decrypted)");
-							$progress->advance();
-						} else {
-							if ($this->decryptFile($path) === false) {
-								$progress->setMessage("decrypt files for user $userCount: $path (already decrypted)");
-								$progress->advance();
-							}
-						}
-					} catch (\Exception $e) {
-						if (isset($this->failed[$uid])) {
-							$this->failed[$uid][] = $path;
-						} else {
-							$this->failed[$uid] = [$path];
-						}
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * encrypt file
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	protected function decryptFile($path) {
-
-		// skip already decrypted files
-		$fileInfo = $this->rootView->getFileInfo($path);
-		if ($fileInfo !== false && !$fileInfo->isEncrypted()) {
-			return true;
-		}
-
-		$source = $path;
-		$target = $path . '.decrypted.' . $this->getTimestamp();
-
-		try {
-			$this->rootView->copy($source, $target);
-			$this->rootView->touch($target, $fileInfo->getMTime());
-			$this->rootView->rename($target, $source);
-		} catch (DecryptionFailedException $e) {
-			if ($this->rootView->file_exists($target)) {
-				$this->rootView->unlink($target);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * get current timestamp
-	 *
-	 * @return int
-	 */
-	protected function getTimestamp() {
-		return time();
-	}
-
-
-	/**
-	 * setup user file system
-	 *
-	 * @param string $uid
-	 */
-	protected function setupUserFS($uid) {
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($uid);
-	}
+    /** @var  OutputInterface */
+    protected $output;
+
+    /** @var  InputInterface */
+    protected $input;
+
+    /** @var  Manager */
+    protected $encryptionManager;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var View */
+    protected $rootView;
+
+    /** @var  array files which couldn't be decrypted */
+    protected $failed;
+
+    /**
+     * @param Manager $encryptionManager
+     * @param IUserManager $userManager
+     * @param View $rootView
+     */
+    public function __construct(
+        Manager $encryptionManager,
+        IUserManager $userManager,
+        View $rootView
+    ) {
+        $this->encryptionManager = $encryptionManager;
+        $this->userManager = $userManager;
+        $this->rootView = $rootView;
+        $this->failed = [];
+    }
+
+    /**
+     * start to decrypt all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @param string $user which users data folder should be decrypted, default = all users
+     * @return bool
+     * @throws \Exception
+     */
+    public function decryptAll(InputInterface $input, OutputInterface $output, $user = '') {
+
+        $this->input = $input;
+        $this->output = $output;
+
+        if ($user !== '' && $this->userManager->userExists($user) === false) {
+            $this->output->writeln('User "' . $user . '" does not exist. Please check the username and try again');
+            return false;
+        }
+
+        $this->output->writeln('prepare encryption modules...');
+        if ($this->prepareEncryptionModules($user) === false) {
+            return false;
+        }
+        $this->output->writeln(' done.');
+
+        $this->decryptAllUsersFiles($user);
+
+        if (empty($this->failed)) {
+            $this->output->writeln('all files could be decrypted successfully!');
+        } else {
+            $this->output->writeln('Files for following users couldn\'t be decrypted, ');
+            $this->output->writeln('maybe the user is not set up in a way that supports this operation: ');
+            foreach ($this->failed as $uid => $paths) {
+                $this->output->writeln('    ' . $uid);
+                foreach ($paths as $path) {
+                    $this->output->writeln('        ' . $path);
+                }
+            }
+            $this->output->writeln('');
+        }
+
+        return true;
+    }
+
+    /**
+     * prepare encryption modules to perform the decrypt all function
+     *
+     * @param $user
+     * @return bool
+     */
+    protected function prepareEncryptionModules($user) {
+        // prepare all encryption modules for decrypt all
+        $encryptionModules = $this->encryptionManager->getEncryptionModules();
+        foreach ($encryptionModules as $moduleDesc) {
+            /** @var IEncryptionModule $module */
+            $module = call_user_func($moduleDesc['callback']);
+            $this->output->writeln('');
+            $this->output->writeln('Prepare "' . $module->getDisplayName() . '"');
+            $this->output->writeln('');
+            if ($module->prepareDecryptAll($this->input, $this->output, $user) === false) {
+                $this->output->writeln('Module "' . $moduleDesc['displayName'] . '" does not support the functionality to decrypt all files again or the initialization of the module failed!');
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * iterate over all user and encrypt their files
+     *
+     * @param string $user which users files should be decrypted, default = all users
+     */
+    protected function decryptAllUsersFiles($user = '') {
+
+        $this->output->writeln("\n");
+
+        $userList = [];
+        if ($user === '') {
+
+            $fetchUsersProgress = new ProgressBar($this->output);
+            $fetchUsersProgress->setFormat(" %message% \n [%bar%]");
+            $fetchUsersProgress->start();
+            $fetchUsersProgress->setMessage("Fetch list of users...");
+            $fetchUsersProgress->advance();
+
+            foreach ($this->userManager->getBackends() as $backend) {
+                $limit = 500;
+                $offset = 0;
+                do {
+                    $users = $backend->getUsers('', $limit, $offset);
+                    foreach ($users as $user) {
+                        $userList[] = $user;
+                    }
+                    $offset += $limit;
+                    $fetchUsersProgress->advance();
+                } while (count($users) >= $limit);
+                $fetchUsersProgress->setMessage("Fetch list of users... finished");
+                $fetchUsersProgress->finish();
+            }
+        } else {
+            $userList[] = $user;
+        }
+
+        $this->output->writeln("\n\n");
+
+        $progress = new ProgressBar($this->output);
+        $progress->setFormat(" %message% \n [%bar%]");
+        $progress->start();
+        $progress->setMessage("starting to decrypt files...");
+        $progress->advance();
+
+        $numberOfUsers = count($userList);
+        $userNo = 1;
+        foreach ($userList as $uid) {
+            $userCount = "$uid ($userNo of $numberOfUsers)";
+            $this->decryptUsersFiles($uid, $progress, $userCount);
+            $userNo++;
+        }
+
+        $progress->setMessage("starting to decrypt files... finished");
+        $progress->finish();
+
+        $this->output->writeln("\n\n");
+
+    }
+
+    /**
+     * encrypt files from the given user
+     *
+     * @param string $uid
+     * @param ProgressBar $progress
+     * @param string $userCount
+     */
+    protected function decryptUsersFiles($uid, ProgressBar $progress, $userCount) {
+
+        $this->setupUserFS($uid);
+        $directories = [];
+        $directories[] = '/' . $uid . '/files';
+
+        while ($root = array_pop($directories)) {
+            $content = $this->rootView->getDirectoryContent($root);
+            foreach ($content as $file) {
+                // only decrypt files owned by the user
+                if($file->getStorage()->instanceOfStorage('OCA\Files_Sharing\SharedStorage')) {
+                    continue;
+                }
+                $path = $root . '/' . $file['name'];
+                if ($this->rootView->is_dir($path)) {
+                    $directories[] = $path;
+                    continue;
+                } else {
+                    try {
+                        $progress->setMessage("decrypt files for user $userCount: $path");
+                        $progress->advance();
+                        if ($file->isEncrypted() === false) {
+                            $progress->setMessage("decrypt files for user $userCount: $path (already decrypted)");
+                            $progress->advance();
+                        } else {
+                            if ($this->decryptFile($path) === false) {
+                                $progress->setMessage("decrypt files for user $userCount: $path (already decrypted)");
+                                $progress->advance();
+                            }
+                        }
+                    } catch (\Exception $e) {
+                        if (isset($this->failed[$uid])) {
+                            $this->failed[$uid][] = $path;
+                        } else {
+                            $this->failed[$uid] = [$path];
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * encrypt file
+     *
+     * @param string $path
+     * @return bool
+     */
+    protected function decryptFile($path) {
+
+        // skip already decrypted files
+        $fileInfo = $this->rootView->getFileInfo($path);
+        if ($fileInfo !== false && !$fileInfo->isEncrypted()) {
+            return true;
+        }
+
+        $source = $path;
+        $target = $path . '.decrypted.' . $this->getTimestamp();
+
+        try {
+            $this->rootView->copy($source, $target);
+            $this->rootView->touch($target, $fileInfo->getMTime());
+            $this->rootView->rename($target, $source);
+        } catch (DecryptionFailedException $e) {
+            if ($this->rootView->file_exists($target)) {
+                $this->rootView->unlink($target);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * get current timestamp
+     *
+     * @return int
+     */
+    protected function getTimestamp() {
+        return time();
+    }
+
+
+    /**
+     * setup user file system
+     *
+     * @param string $uid
+     */
+    protected function setupUserFS($uid) {
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($uid);
+    }
 
 }

lib/private/Encryption/Manager.php

Indentation +236 added lines, -236 removed lines

@@ -38,242 +38,242 @@
 
 class Manager implements IManager {
 
-	/** @var array */
-	protected $encryptionModules;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var Il10n */
-	protected $l;
-
-	/** @var View  */
-	protected $rootView;
-
-	/** @var Util  */
-	protected $util;
-
-	/** @var ArrayCache  */
-	protected $arrayCache;
-
-	/**
-	 * @param IConfig $config
-	 * @param ILogger $logger
-	 * @param IL10N $l10n
-	 * @param View $rootView
-	 * @param Util $util
-	 * @param ArrayCache $arrayCache
-	 */
-	public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) {
-		$this->encryptionModules = [];
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->l = $l10n;
-		$this->rootView = $rootView;
-		$this->util = $util;
-		$this->arrayCache = $arrayCache;
-	}
-
-	/**
-	 * Check if encryption is enabled
-	 *
-	 * @return bool true if enabled, false if not
-	 */
-	public function isEnabled() {
-
-		$installed = $this->config->getSystemValue('installed', false);
-		if (!$installed) {
-			return false;
-		}
-
-		$enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
-		return $enabled === 'yes';
-	}
-
-	/**
-	 * check if new encryption is ready
-	 *
-	 * @return bool
-	 * @throws ServiceUnavailableException
-	 */
-	public function isReady() {
-
-		if ($this->isKeyStorageReady() === false) {
-			throw new ServiceUnavailableException('Key Storage is not ready');
-		}
-
-		return true;
-	}
-
-	/**
-	 * @param string $user
-	 */
-	public function isReadyForUser($user) {
-		if (!$this->isReady()) {
-			return false;
-		}
-
-		foreach ($this->getEncryptionModules() as $module) {
-			/** @var IEncryptionModule $m */
-			$m = call_user_func($module['callback']);
-			if (!$m->isReadyForUser($user)) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-		/**
-	 * Registers an callback function which must return an encryption module instance
-	 *
-	 * @param string $id
-	 * @param string $displayName
-	 * @param callable $callback
-	 * @throws Exceptions\ModuleAlreadyExistsException
-	 */
-	public function registerEncryptionModule($id, $displayName, callable $callback) {
-
-		if (isset($this->encryptionModules[$id])) {
-			throw new Exceptions\ModuleAlreadyExistsException($id, $displayName);
-		}
-
-		$this->encryptionModules[$id] = [
-			'id' => $id,
-			'displayName' => $displayName,
-			'callback' => $callback,
-		];
-
-		$defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId();
-
-		if (empty($defaultEncryptionModuleId)) {
-			$this->setDefaultEncryptionModule($id);
-		}
-	}
-
-	/**
-	 * Unregisters an encryption module
-	 *
-	 * @param string $moduleId
-	 */
-	public function unregisterEncryptionModule($moduleId) {
-		unset($this->encryptionModules[$moduleId]);
-	}
-
-	/**
-	 * get a list of all encryption modules
-	 *
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
-	 */
-	public function getEncryptionModules() {
-		return $this->encryptionModules;
-	}
-
-	/**
-	 * get a specific encryption module
-	 *
-	 * @param string $moduleId
-	 * @return IEncryptionModule
-	 * @throws Exceptions\ModuleDoesNotExistsException
-	 */
-	public function getEncryptionModule($moduleId = '') {
-		if (!empty($moduleId)) {
-			if (isset($this->encryptionModules[$moduleId])) {
-				return call_user_func($this->encryptionModules[$moduleId]['callback']);
-			} else {
-				$message = "Module with ID: $moduleId does not exist.";
-				$hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]);
-				throw new Exceptions\ModuleDoesNotExistsException($message, $hint);
-			}
-		} else {
-			return $this->getDefaultEncryptionModule();
-		}
-	}
-
-	/**
-	 * get default encryption module
-	 *
-	 * @return \OCP\Encryption\IEncryptionModule
-	 * @throws Exceptions\ModuleDoesNotExistsException
-	 */
-	protected function getDefaultEncryptionModule() {
-		$defaultModuleId = $this->getDefaultEncryptionModuleId();
-		if (!empty($defaultModuleId)) {
-			if (isset($this->encryptionModules[$defaultModuleId])) {
-				return call_user_func($this->encryptionModules[$defaultModuleId]['callback']);
-			} else {
-				$message = 'Default encryption module not loaded';
-				throw new Exceptions\ModuleDoesNotExistsException($message);
-			}
-		} else {
-			$message = 'No default encryption module defined';
-			throw new Exceptions\ModuleDoesNotExistsException($message);
-		}
-
-	}
-
-	/**
-	 * set default encryption module Id
-	 *
-	 * @param string $moduleId
-	 * @return bool
-	 */
-	public function setDefaultEncryptionModule($moduleId) {
-		try {
-			$this->getEncryptionModule($moduleId);
-		} catch (\Exception $e) {
-			return false;
-		}
-
-		$this->config->setAppValue('core', 'default_encryption_module', $moduleId);
-		return true;
-	}
-
-	/**
-	 * get default encryption module Id
-	 *
-	 * @return string
-	 */
-	public function getDefaultEncryptionModuleId() {
-		return $this->config->getAppValue('core', 'default_encryption_module');
-	}
-
-	/**
-	 * Add storage wrapper
-	 */
-	public function setupStorage() {
-		// If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper
-		if (!empty($this->encryptionModules) || $this->isEnabled()) {
-			$encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger);
-			Filesystem::addStorageWrapper('oc_encryption', [$encryptionWrapper, 'wrapStorage'], 2);
-		}
-	}
-
-
-	/**
-	 * check if key storage is ready
-	 *
-	 * @return bool
-	 */
-	protected function isKeyStorageReady() {
-
-		$rootDir = $this->util->getKeyStorageRoot();
-
-		// the default root is always valid
-		if ($rootDir === '') {
-			return true;
-		}
-
-		// check if key storage is mounted correctly
-		if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
-			return true;
-		}
-
-		return false;
-	}
+    /** @var array */
+    protected $encryptionModules;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var Il10n */
+    protected $l;
+
+    /** @var View  */
+    protected $rootView;
+
+    /** @var Util  */
+    protected $util;
+
+    /** @var ArrayCache  */
+    protected $arrayCache;
+
+    /**
+     * @param IConfig $config
+     * @param ILogger $logger
+     * @param IL10N $l10n
+     * @param View $rootView
+     * @param Util $util
+     * @param ArrayCache $arrayCache
+     */
+    public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) {
+        $this->encryptionModules = [];
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->l = $l10n;
+        $this->rootView = $rootView;
+        $this->util = $util;
+        $this->arrayCache = $arrayCache;
+    }
+
+    /**
+     * Check if encryption is enabled
+     *
+     * @return bool true if enabled, false if not
+     */
+    public function isEnabled() {
+
+        $installed = $this->config->getSystemValue('installed', false);
+        if (!$installed) {
+            return false;
+        }
+
+        $enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
+        return $enabled === 'yes';
+    }
+
+    /**
+     * check if new encryption is ready
+     *
+     * @return bool
+     * @throws ServiceUnavailableException
+     */
+    public function isReady() {
+
+        if ($this->isKeyStorageReady() === false) {
+            throw new ServiceUnavailableException('Key Storage is not ready');
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $user
+     */
+    public function isReadyForUser($user) {
+        if (!$this->isReady()) {
+            return false;
+        }
+
+        foreach ($this->getEncryptionModules() as $module) {
+            /** @var IEncryptionModule $m */
+            $m = call_user_func($module['callback']);
+            if (!$m->isReadyForUser($user)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+        /**
+         * Registers an callback function which must return an encryption module instance
+         *
+         * @param string $id
+         * @param string $displayName
+         * @param callable $callback
+         * @throws Exceptions\ModuleAlreadyExistsException
+         */
+    public function registerEncryptionModule($id, $displayName, callable $callback) {
+
+        if (isset($this->encryptionModules[$id])) {
+            throw new Exceptions\ModuleAlreadyExistsException($id, $displayName);
+        }
+
+        $this->encryptionModules[$id] = [
+            'id' => $id,
+            'displayName' => $displayName,
+            'callback' => $callback,
+        ];
+
+        $defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId();
+
+        if (empty($defaultEncryptionModuleId)) {
+            $this->setDefaultEncryptionModule($id);
+        }
+    }
+
+    /**
+     * Unregisters an encryption module
+     *
+     * @param string $moduleId
+     */
+    public function unregisterEncryptionModule($moduleId) {
+        unset($this->encryptionModules[$moduleId]);
+    }
+
+    /**
+     * get a list of all encryption modules
+     *
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
+     */
+    public function getEncryptionModules() {
+        return $this->encryptionModules;
+    }
+
+    /**
+     * get a specific encryption module
+     *
+     * @param string $moduleId
+     * @return IEncryptionModule
+     * @throws Exceptions\ModuleDoesNotExistsException
+     */
+    public function getEncryptionModule($moduleId = '') {
+        if (!empty($moduleId)) {
+            if (isset($this->encryptionModules[$moduleId])) {
+                return call_user_func($this->encryptionModules[$moduleId]['callback']);
+            } else {
+                $message = "Module with ID: $moduleId does not exist.";
+                $hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]);
+                throw new Exceptions\ModuleDoesNotExistsException($message, $hint);
+            }
+        } else {
+            return $this->getDefaultEncryptionModule();
+        }
+    }
+
+    /**
+     * get default encryption module
+     *
+     * @return \OCP\Encryption\IEncryptionModule
+     * @throws Exceptions\ModuleDoesNotExistsException
+     */
+    protected function getDefaultEncryptionModule() {
+        $defaultModuleId = $this->getDefaultEncryptionModuleId();
+        if (!empty($defaultModuleId)) {
+            if (isset($this->encryptionModules[$defaultModuleId])) {
+                return call_user_func($this->encryptionModules[$defaultModuleId]['callback']);
+            } else {
+                $message = 'Default encryption module not loaded';
+                throw new Exceptions\ModuleDoesNotExistsException($message);
+            }
+        } else {
+            $message = 'No default encryption module defined';
+            throw new Exceptions\ModuleDoesNotExistsException($message);
+        }
+
+    }
+
+    /**
+     * set default encryption module Id
+     *
+     * @param string $moduleId
+     * @return bool
+     */
+    public function setDefaultEncryptionModule($moduleId) {
+        try {
+            $this->getEncryptionModule($moduleId);
+        } catch (\Exception $e) {
+            return false;
+        }
+
+        $this->config->setAppValue('core', 'default_encryption_module', $moduleId);
+        return true;
+    }
+
+    /**
+     * get default encryption module Id
+     *
+     * @return string
+     */
+    public function getDefaultEncryptionModuleId() {
+        return $this->config->getAppValue('core', 'default_encryption_module');
+    }
+
+    /**
+     * Add storage wrapper
+     */
+    public function setupStorage() {
+        // If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper
+        if (!empty($this->encryptionModules) || $this->isEnabled()) {
+            $encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger);
+            Filesystem::addStorageWrapper('oc_encryption', [$encryptionWrapper, 'wrapStorage'], 2);
+        }
+    }
+
+
+    /**
+     * check if key storage is ready
+     *
+     * @return bool
+     */
+    protected function isKeyStorageReady() {
+
+        $rootDir = $this->util->getKeyStorageRoot();
+
+        // the default root is always valid
+        if ($rootDir === '') {
+            return true;
+        }
+
+        // check if key storage is mounted correctly
+        if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
+            return true;
+        }
+
+        return false;
+    }
 
 
 }