Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactoring / code style #381

Merged
merged 5 commits into from
Sep 20, 2019
Merged

refactoring / code style #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8fd3cfe
refactoring / code style
korelstar Sep 20, 2019
06a4b12
fixup
korelstar Sep 20, 2019
b636b21
fixup
korelstar Sep 20, 2019
c49c404
fixup
korelstar Sep 20, 2019
92e671b
fixup
korelstar Sep 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
108 changes: 92 additions & 16 deletions appinfo/routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,102 @@

return ['routes' => [
// page
['name' => 'page#index', 'url' => '/', 'verb' => 'GET'],
['name' => 'page#index', 'url' => '/welcome', 'verb' => 'GET', 'postfix' => 'welcome'],
['name' => 'page#index', 'url' => '/note/{id}', 'verb' => 'GET', 'postfix' => 'note', 'requirements' => ['id' => '\d+']],
[
'name' => 'page#index',
'url' => '/',
'verb' => 'GET',
],
[
'name' => 'page#index',
'url' => '/welcome',
'verb' => 'GET',
'postfix' => 'welcome',
],
[
'name' => 'page#index',
'url' => '/note/{id}',
'verb' => 'GET',
'postfix' => 'note',
'requirements' => ['id' => '\d+'],
],

// notes
['name' => 'notes#index', 'url' => '/notes', 'verb' => 'GET'],
['name' => 'notes#get', 'url' => '/notes/{id}', 'verb' => 'GET', 'requirements' => ['id' => '\d+']],
['name' => 'notes#create', 'url' => '/notes', 'verb' => 'POST'],
['name' => 'notes#update', 'url' => '/notes/{id}', 'verb' => 'PUT', 'requirements' => ['id' => '\d+']],
['name' => 'notes#category', 'url' => '/notes/{id}/category', 'verb' => 'PUT', 'requirements' => ['id' => '\d+']],
['name' => 'notes#favorite', 'url' => '/notes/{id}/favorite', 'verb' => 'PUT', 'requirements' => ['id' => '\d+']],
['name' => 'notes#destroy', 'url' => '/notes/{id}', 'verb' => 'DELETE', 'requirements' => ['id' => '\d+']],
[
'name' => 'notes#index',
'url' => '/notes',
'verb' => 'GET',
],
[
'name' => 'notes#get',
'url' => '/notes/{id}',
'verb' => 'GET',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes#create',
'url' => '/notes',
'verb' => 'POST',
],
[
'name' => 'notes#update',
'url' => '/notes/{id}',
'verb' => 'PUT',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes#category',
'url' => '/notes/{id}/category',
'verb' => 'PUT',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes#favorite',
'url' => '/notes/{id}/favorite',
'verb' => 'PUT',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes#destroy',
'url' => '/notes/{id}',
'verb' => 'DELETE',
'requirements' => ['id' => '\d+'],
],

// api
['name' => 'notes_api#index', 'url' => '/api/v0.2/notes', 'verb' => 'GET'],
['name' => 'notes_api#get', 'url' => '/api/v0.2/notes/{id}', 'verb' => 'GET', 'requirements' => ['id' => '\d+']],
['name' => 'notes_api#create', 'url' => '/api/v0.2/notes', 'verb' => 'POST'],
['name' => 'notes_api#update', 'url' => '/api/v0.2/notes/{id}', 'verb' => 'PUT', 'requirements' => ['id' => '\d+']],
['name' => 'notes_api#destroy', 'url' => '/api/v0.2/notes/{id}', 'verb' => 'DELETE', 'requirements' => ['id' => '\d+']],
['name' => 'notes_api#preflighted_cors', 'url' => '/api/v0.2/{path}', 'verb' => 'OPTIONS', 'requirements' => ['path' => '.+']],
[
'name' => 'notes_api#index',
'url' => '/api/v0.2/notes',
'verb' => 'GET',
],
[
'name' => 'notes_api#get',
'url' => '/api/v0.2/notes/{id}',
'verb' => 'GET',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes_api#create',
'url' => '/api/v0.2/notes',
'verb' => 'POST',
],
[
'name' => 'notes_api#update',
'url' => '/api/v0.2/notes/{id}',
'verb' => 'PUT',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes_api#destroy',
'url' => '/api/v0.2/notes/{id}',
'verb' => 'DELETE',
'requirements' => ['id' => '\d+'],
],
[
'name' => 'notes_api#preflighted_cors',
'url' => '/api/v0.2/{path}',
'verb' => 'OPTIONS',
'requirements' => ['path' => '.+'],
],

// settings
['name' => 'settings#set', 'url' => '/settings', 'verb' => 'PUT'],
Expand Down
8 changes: 7 additions & 1 deletion lib/Controller/NotesApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@ class NotesApiController extends ApiController {
* @param NotesService $service
* @param IUserSession $userSession
*/
public function __construct($AppName, IRequest $request, NotesService $service, MetaService $metaService, IUserSession $userSession) {
public function __construct(
$AppName,
IRequest $request,
NotesService $service,
MetaService $metaService,
IUserSession $userSession
) {
parent::__construct($AppName, $request);
$this->service = $service;
$this->metaService = $metaService;
Expand Down
220 changes: 220 additions & 0 deletions lib/Service/NoteUtil.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
<?php

namespace OCA\Notes\Service;

use OCP\IL10N;
use OCP\ILogger;
use OCP\Encryption\Exceptions\GenericEncryptionException;
use OCP\Files\IRootFolder;
use OCP\Files\FileInfo;
use OCP\Files\File;
use OCP\Files\Folder;

use OCA\Notes\Db\Note;

class NoteUtil {

private $l10n;
private $root;
private $logger;
private $appName;

/**
* @param IRootFolder $root
* @param IL10N $l10n
* @param ILogger $logger
* @param String $appName
*/
public function __construct(
IRootFolder $root,
IL10N $l10n,
ILogger $logger,
$appName
) {
$this->root = $root;
$this->l10n = $l10n;
$this->logger = $logger;
$this->appName = $appName;
}

/**
* gather note files in given directory and all subdirectories
*/
public function gatherNoteFiles(Folder $folder) : array {
$notes = [];
$nodes = $folder->getDirectoryListing();
foreach ($nodes as $node) {
if ($node->getType() === FileInfo::TYPE_FOLDER) {
$notes = array_merge($notes, $this->gatherNoteFiles($node));
continue;
}
if ($this->isNote($node)) {
$notes[] = $node;
}
}
return $notes;
}


/**
* test if file is a note
*/
public function isNote(File $file) : bool {
$allowedExtensions = ['txt', 'org', 'markdown', 'md', 'note'];
$ext = strtolower(pathinfo($file->getName(), PATHINFO_EXTENSION));
return $file->getType() === 'file' && in_array($ext, $allowedExtensions);
}

public function moveNote(Folder $notesFolder, File $file, $category, string $title) {
$id = $file->getId();
$currentFilePath = $this->root->getFullPath($file->getPath());
$currentBasePath = pathinfo($currentFilePath, PATHINFO_DIRNAME);
$fileSuffix = '.' . pathinfo($file->getName(), PATHINFO_EXTENSION);

// detect (new) folder path based on category name
if ($category===null) {
$basePath = $currentBasePath;
} else {
$basePath = $notesFolder->getPath();
if (!empty($category)) {
// sanitise path
$cats = explode('/', $category);
$cats = array_map([$this, 'sanitisePath'], $cats);
$cats = array_filter($cats, function ($str) {
return !empty($str);
});
$basePath .= '/'.implode('/', $cats);
}
}
$folder = $this->getOrCreateFolder($basePath);

// assemble new file path
$newFilePath = $basePath . '/' . $this->generateFileName($folder, $title, $fileSuffix, $id);

// if the current path is not the new path, the file has to be renamed
if ($currentFilePath !== $newFilePath) {
$file->move($newFilePath);
}
if ($currentBasePath !== $basePath) {
$this->deleteEmptyFolder($notesFolder, $this->root->get($currentBasePath));
}
}

/**
* get path of file and the title.txt and check if they are the same
* file. If not the title needs to be renamed
*
* @param Folder $folder a folder to the notes directory
* @param string $title the filename which should be used
* @param string $suffix the suffix (incl. dot) which should be used
* @param int $id the id of the note for which the title should be generated
* used to see if the file itself has the title and not a different file for
* checking for filename collisions
* @return string the resolved filename to prevent overwriting different
* files with the same title
*/
public function generateFileName(Folder $folder, string $title, string $suffix, int $id) : string {
$path = $title . $suffix;

// if file does not exist, that name has not been taken. Similar we don't
// need to handle file collisions if it is the filename did not change
if (!$folder->nodeExists($path) || $folder->get($path)->getId() === $id) {
return $path;
} else {
// increments name (2) to name (3)
$match = preg_match('/\((?P<id>\d+)\)$/u', $title, $matches);
if ($match) {
$newId = ((int) $matches['id']) + 1;
$newTitle = preg_replace(
'/(.*)\s\((\d+)\)$/u',
'$1 (' . $newId . ')',
$title
);
} else {
$newTitle = $title . ' (2)';
}
return $this->generateFileName($folder, $newTitle, $suffix, $id);
}
}

public function getSafeTitleFromContent(string $content) : string {
// prepare content: remove markdown characters and empty spaces
$content = preg_replace("/^\s*[*+-]\s+/mu", "", $content); // list item
$content = preg_replace("/^#+\s+(.*?)\s*#*$/mu", "$1", $content); // headline
$content = preg_replace("/^(=+|-+)$/mu", "", $content); // separate line for headline
$content = preg_replace("/(\*+|_+)(.*?)\\1/mu", "$2", $content); // emphasis

// sanitize: prevent directory traversal, illegal characters and unintended file names
$content = $this->sanitisePath($content);

// generate title from the first line of the content
$splitContent = preg_split("/\R/u", $content, 2);
$title = trim($splitContent[0]);

// using a maximum of 100 chars should be enough
$title = mb_substr($title, 0, 100, "UTF-8");

// ensure that title is not empty
if (empty($title)) {
$title = $this->l10n->t('New note');
}

return $title;
}

/** removes characters that are illegal in a file or folder name on some operating systems */
public function sanitisePath(string $str) : string {
// remove characters which are illegal on Windows (includes illegal characters on Unix/Linux)
// prevents also directory traversal by eliminiating slashes
// see also \OC\Files\Storage\Common::verifyPosixPath(...)
$str = str_replace(['*', '|', '/', '\\', ':', '"', '<', '>', '?'], '', $str);

// if mysql doesn't support 4byte UTF-8, then remove those characters
// see \OC\Files\Storage\Common::verifyPath(...)
if (!\OC::$server->getDatabaseConnection()->supports4ByteText()) {
$str = preg_replace('%(?:
\xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
| [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
| \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
)%xs', '', $str);
}

// prevent file to be hidden
$str = preg_replace("/^[\. ]+/mu", "", $str);
return trim($str);
}

/**
* Finds a folder and creates it if non-existent
* @param string $path path to the folder
* @return Folder
*/
public function getOrCreateFolder(string $path) : Folder {
if ($this->root->nodeExists($path)) {
$folder = $this->root->get($path);
} else {
$folder = $this->root->newFolder($path);
}
if (!($folder instanceof Folder)) {
throw new NotesFolderException($path.' is not a folder');
}
return $folder;
}

/*
* Delete a folder and it's parent(s) if it's/they're empty
* @param Folder root folder for notes
* @param Folder folder to delete
*/
public function deleteEmptyFolder(Folder $notesFolder, Folder $folder) {
$content = $folder->getDirectoryListing();
$isEmpty = !count($content);
$isNotesFolder = $folder->getPath()===$notesFolder->getPath();
if ($isEmpty && !$isNotesFolder) {
$this->logger->info('Deleting empty category folder '.$folder->getPath(), ['app' => $this->appName]);
$parent = $folder->getParent();
$folder->delete();
$this->deleteEmptyFolder($notesFolder, $parent);
}
}
}