aboutsummaryrefslogtreecommitdiffstats
path: root/lib/vobject.php
blob: 267176ebc070f8590254ad6b38b8e5f6d9e3363e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?php
/**
 * ownCloud
 *
 * @author Bart Visscher
 * @copyright 2011 Bart Visscher bartv@thisnet.nl
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/**
 * This class provides a streamlined interface to the Sabre VObject classes
 */
class OC_VObject{
	/** @var Sabre\VObject\Component */
	protected $vobject;

	/**
	 * @returns Sabre\VObject\Component
	 */
	public function getVObject() {
		return $this->vobject;
	}

	/**
	 * @brief Parses the VObject
	 * @param string VObject as string
	 * @returns Sabre_VObject or null
	 */
	public static function parse($data) {
		try {
			Sabre\VObject\Property::$classMap['LAST-MODIFIED'] = 'Sabre\VObject\Property\DateTime';
			$vobject = Sabre\VObject\Reader::read($data);
			if ($vobject instanceof Sabre\VObject\Component) {
				$vobject = new OC_VObject($vobject);
			}
			return $vobject;
		} catch (Exception $e) {
			OC_Log::write('vobject', $e->getMessage(), OC_Log::ERROR);
			return null;
		}
	}

	/**
	 * @brief Escapes semicolons
	 * @param string $value
	 * @return string
	 */
	public static function escapeSemicolons($value) {
		foreach($value as &$i ) {
			$i = implode("\\\\;", explode(';', $i));
		}
		return implode(';', $value);
	}

	/**
	 * @brief Creates an array out of a multivalue property
	 * @param string $value
	 * @return array
	 */
	public static function unescapeSemicolons($value) {
		$array = explode(';', $value);
		for($i=0;$i<count($array);$i++) {
			if(substr($array[$i], -2, 2)=="\\\\") {
				if(isset($array[$i+1])) {
					$array[$i] = substr($array[$i], 0, count($array[$i])-2).';'.$array[$i+1];
					unset($array[$i+1]);
				}
				else{
					$array[$i] = substr($array[$i], 0, count($array[$i])-2).';';
				}
				$i = $i - 1;
			}
		}
		return $array;
	}

	/**
	 * Constuctor
	 * @param Sabre\VObject\Component or string
	 */
	public function __construct($vobject_or_name) {
		if (is_object($vobject_or_name)) {
			$this->vobject = $vobject_or_name;
		} else {
			$this->vobject = new Sabre\VObject\Component($vobject_or_name);
		}
	}

	public function add($item, $itemValue = null) {
		if ($item instanceof OC_VObject) {
			$item = $item->getVObject();
		}
		$this->vobject->add($item, $itemValue);
	}

	/**
	 * @brief Add property to vobject
	 * @param object $name of property
	 * @param object $value of property
	 * @param object $parameters of property
	 * @returns Sabre_VObject_Property newly created
	 */
	public function addProperty($name, $value, $parameters=array()) {
		if(is_array($value)) {
			$value = OC_VObject::escapeSemicolons($value);
		}
		$property = new Sabre\VObject\Property( $name, $value );
		foreach($parameters as $name => $value) {
			$property->parameters[] = new Sabre\VObject\Parameter($name, $value);
		}

		$this->vobject->add($property);
		return $property;
	}

	public function setUID() {
		$uid = substr(md5(rand().time()), 0, 10);
		$this->vobject->add('UID', $uid);
	}

	public function setString($name, $string) {
		if ($string != '') {
			$string = strtr($string, array("\r\n"=>"\n"));
			$this->vobject->__set($name, $string);
		}else{
			$this->vobject->__unset($name);
		}
	}

	/**
	 * Sets or unsets the Date and Time for a property.
	 * When $datetime is set to 'now', use the current time
	 * When $datetime is null, unset the property
	 *
	 * @param string property name
	 * @param DateTime $datetime
	 * @param int $dateType
	 * @return void
	 */
	public function setDateTime($name, $datetime, $dateType=Sabre\VObject\Property\DateTime::LOCALTZ) {
		if ($datetime == 'now') {
			$datetime = new DateTime();
		}
		if ($datetime instanceof DateTime) {
			$datetime_element = new Sabre\VObject\Property\DateTime($name);
			$datetime_element->setDateTime($datetime, $dateType);
			$this->vobject->__set($name, $datetime_element);
		}else{
			$this->vobject->__unset($name);
		}
	}

	public function getAsString($name) {
		return $this->vobject->__isset($name) ?
			$this->vobject->__get($name)->value :
			'';
	}

	public function getAsArray($name) {
		$values = array();
		if ($this->vobject->__isset($name)) {
			$values = explode(',', $this->getAsString($name));
			$values = array_map('trim', $values);
		}
		return $values;
	}

	public function &__get($name) {
		if ($name == 'children') {
			return $this->vobject->children;
		}
		$return = $this->vobject->__get($name);
		if ($return instanceof Sabre\VObject\Component) {
			$return = new OC_VObject($return);
		}
		return $return;
	}

	public function __set($name, $value) {
		return $this->vobject->__set($name, $value);
	}

	public function __unset($name) {
		return $this->vobject->__unset($name);
	}

	public function __isset($name) {
		return $this->vobject->__isset($name);
	}

	public function __call($function, $arguments) {
		return call_user_func_array(array($this->vobject, $function), $arguments);
	}
}
class="p">( $this->config, $this, $this->appData, new GeneratorHelper( $this->rootFolder, $this->config ), $this->legacyEventDispatcher, $this->eventDispatcher ); } return $this->generator; } /** * Returns a preview of a file * * The cache is searched first and if nothing usable was found then a preview is * generated by one of the providers * * @param File $file * @param int $width * @param int $height * @param bool $crop * @param string $mode * @param string $mimeType * @return ISimpleFile * @throws NotFoundException * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0 */ public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) { $previewConcurrency = $this->getGenerator()->getNumConcurrentPreviews('preview_concurrency_all'); $sem = Generator::guardWithSemaphore(Generator::SEMAPHORE_ID_ALL, $previewConcurrency); try { $preview = $this->getGenerator()->getPreview($file, $width, $height, $crop, $mode, $mimeType); } finally { Generator::unguardWithSemaphore($sem); } return $preview; } /** * Generates previews of a file * * @param File $file * @param array $specifications * @param string $mimeType * @return ISimpleFile the last preview that was generated * @throws NotFoundException * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) * @since 19.0.0 */ public function generatePreviews(File $file, array $specifications, $mimeType = null) { return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType); } /** * returns true if the passed mime type is supported * * @param string $mimeType * @return boolean */ public function isMimeSupported($mimeType = '*') { if (!$this->config->getSystemValue('enable_previews', true)) { return false; } if (isset($this->mimeTypeSupportMap[$mimeType])) { return $this->mimeTypeSupportMap[$mimeType]; } $this->registerCoreProviders(); $this->registerBootstrapProviders(); $providerMimeTypes = array_keys($this->providers); foreach ($providerMimeTypes as $supportedMimeType) { if (preg_match($supportedMimeType, $mimeType)) { $this->mimeTypeSupportMap[$mimeType] = true; return true; } } $this->mimeTypeSupportMap[$mimeType] = false; return false; } /** * Check if a preview can be generated for a file */ public function isAvailable(\OCP\Files\FileInfo $file): bool { if (!$this->config->getSystemValue('enable_previews', true)) { return false; } $this->registerCoreProviders(); if (!$this->isMimeSupported($file->getMimetype())) { return false; } $mount = $file->getMountPoint(); if ($mount and !$mount->getOption('previews', true)) { return false; } foreach ($this->providers as $supportedMimeType => $providers) { if (preg_match($supportedMimeType, $file->getMimetype())) { foreach ($providers as $providerClosure) { $provider = $this->helper->getProvider($providerClosure); if (!($provider instanceof IProviderV2)) { continue; } if ($provider->isAvailable($file)) { return true; } } } } return false; } /** * List of enabled default providers * * The following providers are enabled by default: * - OC\Preview\PNG * - OC\Preview\JPEG * - OC\Preview\GIF * - OC\Preview\BMP * - OC\Preview\XBitmap * - OC\Preview\MarkDown * - OC\Preview\MP3 * - OC\Preview\TXT * * The following providers are disabled by default due to performance or privacy concerns: * - OC\Preview\Font * - OC\Preview\HEIC * - OC\Preview\Illustrator * - OC\Preview\Movie * - OC\Preview\MSOfficeDoc * - OC\Preview\MSOffice2003 * - OC\Preview\MSOffice2007 * - OC\Preview\OpenDocument * - OC\Preview\PDF * - OC\Preview\Photoshop * - OC\Preview\Postscript * - OC\Preview\StarOffice * - OC\Preview\SVG * - OC\Preview\TIFF * * @return array */ protected function getEnabledDefaultProvider() { if ($this->defaultProviders !== null) { return $this->defaultProviders; } $imageProviders = [ Preview\PNG::class, Preview\JPEG::class, Preview\GIF::class, Preview\BMP::class, Preview\XBitmap::class, Preview\Krita::class, Preview\WebP::class, ]; $this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([ Preview\MarkDown::class, Preview\MP3::class, Preview\TXT::class, Preview\OpenDocument::class, ], $imageProviders)); if (in_array(Preview\Image::class, $this->defaultProviders)) { $this->defaultProviders = array_merge($this->defaultProviders, $imageProviders); } $this->defaultProviders = array_unique($this->defaultProviders); return $this->defaultProviders; } /** * Register the default providers (if enabled) * * @param string $class * @param string $mimeType */ protected function registerCoreProvider($class, $mimeType, $options = []) { if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) { $this->registerProvider($mimeType, function () use ($class, $options) { return new $class($options); }); } } /** * Register the default providers (if enabled) */ protected function registerCoreProviders() { if ($this->registeredCoreProviders) { return; } $this->registeredCoreProviders = true; $this->registerCoreProvider(Preview\TXT::class, '/text\/plain/'); $this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/'); $this->registerCoreProvider(Preview\PNG::class, '/image\/png/'); $this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/'); $this->registerCoreProvider(Preview\GIF::class, '/image\/gif/'); $this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/'); $this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/'); $this->registerCoreProvider(Preview\WebP::class, '/image\/webp/'); $this->registerCoreProvider(Preview\Krita::class, '/application\/x-krita/'); $this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg/'); $this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/'); $this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes()); // SVG, Office and Bitmap require imagick if ($this->imagickSupport->hasExtension()) { $imagickProviders = [ 'SVG' => ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class], 'TIFF' => ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class], 'PDF' => ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class], 'AI' => ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class], 'PSD' => ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class], 'EPS' => ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class], 'TTF' => ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class], 'HEIC' => ['mimetype' => '/image\/hei(f|c)/', 'class' => Preview\HEIC::class], 'TGA' => ['mimetype' => '/image\/t(ar)?ga/', 'class' => Preview\TGA::class], 'SGI' => ['mimetype' => '/image\/sgi/', 'class' => Preview\SGI::class], ]; foreach ($imagickProviders as $queryFormat => $provider) { $class = $provider['class']; if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) { continue; } if ($this->imagickSupport->supportsFormat($queryFormat)) { $this->registerCoreProvider($class, $provider['mimetype']); } } if ($this->imagickSupport->supportsFormat('PDF')) { // Office requires openoffice or libreoffice $officeBinary = $this->config->getSystemValue('preview_libreoffice_path', null); if (!is_string($officeBinary)) { $officeBinary = $this->binaryFinder->findBinaryPath('libreoffice'); } if (!is_string($officeBinary)) { $officeBinary = $this->binaryFinder->findBinaryPath('openoffice'); } if (is_string($officeBinary)) { $this->registerCoreProvider(Preview\MSOfficeDoc::class, '/application\/msword/', ["officeBinary" => $officeBinary]); $this->registerCoreProvider(Preview\MSOffice2003::class, '/application\/vnd.ms-.*/', ["officeBinary" => $officeBinary]); $this->registerCoreProvider(Preview\MSOffice2007::class, '/application\/vnd.openxmlformats-officedocument.*/', ["officeBinary" => $officeBinary]); $this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/', ["officeBinary" => $officeBinary]); $this->registerCoreProvider(Preview\StarOffice::class, '/application\/vnd.sun.xml.*/', ["officeBinary" => $officeBinary]); } } } // Video requires avconv or ffmpeg if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) { $movieBinary = $this->config->getSystemValue('preview_ffmpeg_path', null); if (!is_string($movieBinary)) { $movieBinary = $this->binaryFinder->findBinaryPath('avconv'); if (!is_string($movieBinary)) { $movieBinary = $this->binaryFinder->findBinaryPath('ffmpeg'); } } if (is_string($movieBinary)) { $this->registerCoreProvider(Preview\Movie::class, '/video\/.*/', ["movieBinary" => $movieBinary]); } } } private function registerBootstrapProviders(): void { $context = $this->bootstrapCoordinator->getRegistrationContext(); if ($context === null) { // Just ignore for now return; } $providers = $context->getPreviewProviders(); foreach ($providers as $provider) { $key = $provider->getMimeTypeRegex() . '-' . $provider->getService(); if (array_key_exists($key, $this->loadedBootstrapProviders)) { // Do not load the provider more than once continue; } $this->loadedBootstrapProviders[$key] = null; $this->registerProvider($provider->getMimeTypeRegex(), function () use ($provider) { try { return $this->container->get($provider->getService()); } catch (QueryException $e) { return null; } }); } } }