123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361 |
- <?php
- declare(strict_types=1);
- namespace OC\Files\Template;
- use OC\AppFramework\Bootstrap\Coordinator;
- use OC\Files\Cache\Scanner;
- use OC\Files\Filesystem;
- use OCP\EventDispatcher\IEventDispatcher;
- use OCP\Files\File;
- use OCP\Files\Folder;
- use OCP\Files\GenericFileException;
- use OCP\Files\IRootFolder;
- use OCP\Files\Node;
- use OCP\Files\NotFoundException;
- use OCP\Files\Template\BeforeGetTemplatesEvent;
- use OCP\Files\Template\FileCreatedFromTemplateEvent;
- use OCP\Files\Template\ICustomTemplateProvider;
- use OCP\Files\Template\ITemplateManager;
- use OCP\Files\Template\RegisterTemplateCreatorEvent;
- use OCP\Files\Template\Template;
- use OCP\Files\Template\TemplateFileCreator;
- use OCP\IConfig;
- use OCP\IPreview;
- use OCP\IServerContainer;
- use OCP\IUserManager;
- use OCP\IUserSession;
- use OCP\L10N\IFactory;
- use Psr\Log\LoggerInterface;
- class TemplateManager implements ITemplateManager {
- private $registeredTypes = [];
- private $types = [];
-
- private $providers = null;
- private $serverContainer;
- private $eventDispatcher;
- private $rootFolder;
- private $userManager;
- private $previewManager;
- private $config;
- private $l10n;
- private $logger;
- private $userId;
- private $l10nFactory;
-
- private $bootstrapCoordinator;
- public function __construct(
- IServerContainer $serverContainer,
- IEventDispatcher $eventDispatcher,
- Coordinator $coordinator,
- IRootFolder $rootFolder,
- IUserSession $userSession,
- IUserManager $userManager,
- IPreview $previewManager,
- IConfig $config,
- IFactory $l10nFactory,
- LoggerInterface $logger,
- ) {
- $this->serverContainer = $serverContainer;
- $this->eventDispatcher = $eventDispatcher;
- $this->bootstrapCoordinator = $coordinator;
- $this->rootFolder = $rootFolder;
- $this->userManager = $userManager;
- $this->previewManager = $previewManager;
- $this->config = $config;
- $this->l10nFactory = $l10nFactory;
- $this->l10n = $l10nFactory->get('lib');
- $this->logger = $logger;
- $user = $userSession->getUser();
- $this->userId = $user ? $user->getUID() : null;
- }
- public function registerTemplateFileCreator(callable $callback): void {
- $this->registeredTypes[] = $callback;
- }
- public function getRegisteredProviders(): array {
- if ($this->providers !== null) {
- return $this->providers;
- }
- $context = $this->bootstrapCoordinator->getRegistrationContext();
- $this->providers = [];
- foreach ($context->getTemplateProviders() as $provider) {
- $class = $provider->getService();
- $this->providers[$class] = $this->serverContainer->get($class);
- }
- return $this->providers;
- }
- public function getTypes(): array {
- if (!empty($this->types)) {
- return $this->types;
- }
- $this->eventDispatcher->dispatchTyped(new RegisterTemplateCreatorEvent($this));
- foreach ($this->registeredTypes as $registeredType) {
- $this->types[] = $registeredType();
- }
- return $this->types;
- }
- public function listCreators(): array {
- $types = $this->getTypes();
- usort($types, function (TemplateFileCreator $a, TemplateFileCreator $b) {
- return $a->getOrder() - $b->getOrder();
- });
- return $types;
- }
- public function listTemplates(): array {
- return array_values(array_map(function (TemplateFileCreator $entry) {
- return array_merge($entry->jsonSerialize(), [
- 'templates' => $this->getTemplateFiles($entry)
- ]);
- }, $this->listCreators()));
- }
-
- public function createFromTemplate(string $filePath, string $templateId = '', string $templateType = 'user', array $templateFields = []): array {
- $userFolder = $this->rootFolder->getUserFolder($this->userId);
- try {
- $userFolder->get($filePath);
- throw new GenericFileException($this->l10n->t('File already exists'));
- } catch (NotFoundException $e) {
- }
- try {
- if (!$userFolder->nodeExists(dirname($filePath))) {
- throw new GenericFileException($this->l10n->t('Invalid path'));
- }
- $folder = $userFolder->get(dirname($filePath));
- $template = null;
- if ($templateType === 'user' && $templateId !== '') {
- $template = $userFolder->get($templateId);
- } else {
- $matchingProvider = array_filter($this->getRegisteredProviders(), function (ICustomTemplateProvider $provider) use ($templateType) {
- return $templateType === get_class($provider);
- });
- $provider = array_shift($matchingProvider);
- if ($provider) {
- $template = $provider->getCustomTemplate($templateId);
- }
- }
- $targetFile = $folder->newFile(basename($filePath), ($template instanceof File ? $template->fopen('rb') : null));
- $this->eventDispatcher->dispatchTyped(new FileCreatedFromTemplateEvent($template, $targetFile, $templateFields));
- return $this->formatFile($userFolder->get($filePath));
- } catch (\Exception $e) {
- $this->logger->error($e->getMessage(), ['exception' => $e]);
- throw new GenericFileException($this->l10n->t('Failed to create file from template'));
- }
- }
-
- private function getTemplateFolder(): Folder {
- if ($this->getTemplatePath() !== '') {
- $path = $this->rootFolder->getUserFolder($this->userId)->get($this->getTemplatePath());
- if ($path instanceof Folder) {
- return $path;
- }
- $this->logger->warning('Template folder ' . $path . ' not found or invalid', ['app' => 'files_templates']);
- }
- throw new NotFoundException();
- }
-
- private function getTemplateFiles(TemplateFileCreator $type): array {
- $templates = [];
- foreach ($this->getRegisteredProviders() as $provider) {
- foreach ($type->getMimetypes() as $mimetype) {
- foreach ($provider->getCustomTemplates($mimetype) as $template) {
- $templates[] = $template;
- }
- }
- }
- try {
- $userTemplateFolder = $this->getTemplateFolder();
- } catch (\Exception $e) {
- return $templates;
- }
- foreach ($type->getMimetypes() as $mimetype) {
- foreach ($userTemplateFolder->searchByMime($mimetype) as $templateFile) {
- $template = new Template(
- 'user',
- $this->rootFolder->getUserFolder($this->userId)->getRelativePath($templateFile->getPath()),
- $templateFile
- );
- $template->setHasPreview($this->previewManager->isAvailable($templateFile));
- $templates[] = $template;
- }
- }
- $this->eventDispatcher->dispatchTyped(new BeforeGetTemplatesEvent($templates));
- return $templates;
- }
-
- private function formatFile(Node $file): array {
- return [
- 'basename' => $file->getName(),
- 'etag' => $file->getEtag(),
- 'fileid' => $file->getId(),
- 'filename' => $this->rootFolder->getUserFolder($this->userId)->getRelativePath($file->getPath()),
- 'lastmod' => $file->getMTime(),
- 'mime' => $file->getMimetype(),
- 'size' => $file->getSize(),
- 'type' => $file->getType(),
- 'hasPreview' => $this->previewManager->isAvailable($file),
- 'permissions' => $file->getPermissions(),
- ];
- }
- public function hasTemplateDirectory(): bool {
- try {
- $this->getTemplateFolder();
- return true;
- } catch (\Exception $e) {
- }
- return false;
- }
- public function setTemplatePath(string $path): void {
- $this->config->setUserValue($this->userId, 'core', 'templateDirectory', $path);
- }
- public function getTemplatePath(): string {
- return $this->config->getUserValue($this->userId, 'core', 'templateDirectory', '');
- }
- public function initializeTemplateDirectory(?string $path = null, ?string $userId = null, $copyTemplates = true): string {
- if ($userId !== null) {
- $this->userId = $userId;
- }
- $defaultSkeletonDirectory = \OC::$SERVERROOT . '/core/skeleton';
- $defaultTemplateDirectory = \OC::$SERVERROOT . '/core/skeleton/Templates';
- $skeletonPath = $this->config->getSystemValueString('skeletondirectory', $defaultSkeletonDirectory);
- $skeletonTemplatePath = $this->config->getSystemValueString('templatedirectory', $defaultTemplateDirectory);
- $isDefaultSkeleton = $skeletonPath === $defaultSkeletonDirectory;
- $isDefaultTemplates = $skeletonTemplatePath === $defaultTemplateDirectory;
- $userLang = $this->l10nFactory->getUserLanguage($this->userManager->get($this->userId));
- if ($skeletonTemplatePath === '') {
- $this->setTemplatePath('');
- return '';
- }
- try {
- $l10n = $this->l10nFactory->get('lib', $userLang);
- $userFolder = $this->rootFolder->getUserFolder($this->userId);
- $userTemplatePath = $path ?? $this->config->getAppValue('core', 'defaultTemplateDirectory', $l10n->t('Templates')) . '/';
-
- if ($path === null) {
-
- if ($isDefaultSkeleton && $isDefaultTemplates) {
- if (!$userFolder->nodeExists('Templates')) {
- return '';
- }
- $newPath = Filesystem::normalizePath($userFolder->getPath() . '/' . $userTemplatePath);
- if ($newPath !== $userFolder->get('Templates')->getPath()) {
- $userFolder->get('Templates')->move($newPath);
- }
- $this->setTemplatePath($userTemplatePath);
- return $userTemplatePath;
- }
- if ($isDefaultSkeleton && !empty($skeletonTemplatePath) && !$isDefaultTemplates && $userFolder->nodeExists('Templates')) {
- $shippedSkeletonTemplates = $userFolder->get('Templates');
- $shippedSkeletonTemplates->delete();
- }
- }
- try {
- $folder = $userFolder->get($userTemplatePath);
- } catch (NotFoundException $e) {
- $folder = $userFolder->get(dirname($userTemplatePath));
- $folder = $folder->newFolder(basename($userTemplatePath));
- }
- $folderIsEmpty = count($folder->getDirectoryListing()) === 0;
- if (!$copyTemplates) {
- $this->setTemplatePath($userTemplatePath);
- return $userTemplatePath;
- }
- if (!$isDefaultTemplates && $folderIsEmpty) {
- $localizedSkeletonTemplatePath = $this->getLocalizedTemplatePath($skeletonTemplatePath, $userLang);
- if (!empty($localizedSkeletonTemplatePath) && file_exists($localizedSkeletonTemplatePath)) {
- \OC_Util::copyr($localizedSkeletonTemplatePath, $folder);
- $userFolder->getStorage()->getScanner()->scan($folder->getInternalPath(), Scanner::SCAN_RECURSIVE);
- $this->setTemplatePath($userTemplatePath);
- return $userTemplatePath;
- }
- }
- if ($path !== null && $isDefaultSkeleton && $isDefaultTemplates && $folderIsEmpty) {
- $localizedSkeletonPath = $this->getLocalizedTemplatePath($skeletonPath . '/Templates', $userLang);
- if (!empty($localizedSkeletonPath) && file_exists($localizedSkeletonPath)) {
- \OC_Util::copyr($localizedSkeletonPath, $folder);
- $userFolder->getStorage()->getScanner()->scan($folder->getInternalPath(), Scanner::SCAN_RECURSIVE);
- $this->setTemplatePath($userTemplatePath);
- return $userTemplatePath;
- }
- }
- $this->setTemplatePath($path ?? '');
- return $this->getTemplatePath();
- } catch (\Throwable $e) {
- $this->logger->error('Failed to initialize templates directory to user language ' . $userLang . ' for ' . $userId, ['app' => 'files_templates', 'exception' => $e]);
- }
- $this->setTemplatePath('');
- return $this->getTemplatePath();
- }
- private function getLocalizedTemplatePath(string $skeletonTemplatePath, string $userLang) {
- $localizedSkeletonTemplatePath = str_replace('{lang}', $userLang, $skeletonTemplatePath);
- if (!file_exists($localizedSkeletonTemplatePath)) {
- $dialectStart = strpos($userLang, '_');
- if ($dialectStart !== false) {
- $localizedSkeletonTemplatePath = str_replace('{lang}', substr($userLang, 0, $dialectStart), $skeletonTemplatePath);
- }
- if ($dialectStart === false || !file_exists($localizedSkeletonTemplatePath)) {
- $localizedSkeletonTemplatePath = str_replace('{lang}', 'default', $skeletonTemplatePath);
- }
- }
- return $localizedSkeletonTemplatePath;
- }
- }
|