NotesService::getAll() - Code Metrics - Inspection of "New feature: set a note as favorite (star/unstar)" - owncloud/notes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#248)

unknown

created 2016-10-16 17:34 UTC

NotesService::getAll() B

↳ Parent: NotesService

Complexity

Conditions	6
Paths	12

Size

Total Lines	24
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	6

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	24
ccs	12
cts	12
cp	1
rs	8.5125
cc	6
eloc	16
nc	12
nop	1
crap	6

<?php
/**
 * ownCloud - Notes
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Bernhard Posselt <[email protected]>
 * @copyright Bernhard Posselt 2012, 2014
 */

namespace OCA\Notes\Service;

use OCP\IL10N;
use OCP\Files\IRootFolder;
use OCP\Files\Folder;

use OCA\Notes\Db\Note;

/**
 * Class NotesService
 *
 * @package OCA\Notes\Service
 */
class NotesService {

    private $l10n;
    private $root;

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


    /**
     * @param string $userId
     * @return array with all notes in the current directory
     */
    public function getAll ($userId){
        $folder = $this->getFolderForUser($userId);
        $files = $folder->getDirectoryListing();
        $filesById = [];
        foreach($files as $file) {
            if($this->isNote($file)) {
                $filesById[$file->getId()] = $file;
            }
        }
        $tagger = \OC::$server->getTagManager()->load('files');
        $tags = $tagger->getTagsForObjects(array_keys($filesById));
        if ($tags) {
            foreach ($tags as $fileId => $fileTags) {
                $filesById[$fileId]->getFileInfo()->offsetSet('tags', $fileTags);
            }
        }

        $notes = [];
        foreach($filesById as $file) {
            $notes[] = Note::fromFile($file);
        }

        return $notes;
    }


    /**
     * Used to get a single note by id
     * @param int $id the id of the note to get
     * @param string $userId
     * @throws NoteDoesNotExistException if note does not exist
     * @return Note
     */
    public function get ($id, $userId) {
        $folder = $this->getFolderForUser($userId);
        return Note::fromFile($this->getFileById($folder, $id));
    }


    /**
     * Creates a note and returns the empty note
     * @param string $userId
     * @see update for setting note content
     * @return Note the newly created note
     */
    public function create ($userId) {
        $title = $this->l10n->t('New note');
        $folder = $this->getFolderForUser($userId);

        // check new note exists already and we need to number it
        // pass -1 because no file has id -1 and that will ensure
        // to only return filenames that dont yet exist
        $path = $this->generateFileName($folder, $title, "txt", -1);
        $file = $folder->newFile($path);

        return Note::fromFile($file);
    }


    /**
     * Updates a note. Be sure to check the returned note since the title is
     * dynamically generated and filename conflicts are resolved
     * @param int $id the id of the note used to update
     * @param string $content the content which will be written into the note
     * the title is generated from the first line of the content
     * @throws NoteDoesNotExistException if note does not exist
     * @return \OCA\Notes\Db\Note the updated note
     */
    public function update ($id, $content, $userId){
        $folder = $this->getFolderForUser($userId);
        $file = $this->getFileById($folder, $id);

        // generate content from the first line of the title
        $splitContent = explode("\n", $content);
        $title = $splitContent[0];

        if(!$title) {
            $title = $this->l10n->t('New note');
        }

        // prevent directory traversal
        $title = str_replace(array('/', '\\'), '',  $title);
        // remove hash and space characters from the beginning of the filename
        // in case of markdown
        $title = ltrim($title, ' #');
        // using a maximum of 100 chars should be enough
        $title = mb_substr($title, 0, 100, "UTF-8");

        // generate filename if there were collisions
        $currentFilePath = $file->getPath();
        $basePath = '/' . $userId . '/files/Notes/';
        $fileExtension = pathinfo($file->getName(), PATHINFO_EXTENSION);
        $newFilePath = $basePath . $this->generateFileName($folder, $title, $fileExtension, $id);

        // if the current path is not the new path, the file has to be renamed
        if($currentFilePath !== $newFilePath) {
            $file->move($newFilePath);
        }

        $file->putContent($content);

        return Note::fromFile($file);
    }


    /**
     * Set or unset a note as favorite.
     * @param int $id the id of the note used to update
     * @param boolean $favorite whether the note should be a favorite or not
     * @throws NoteDoesNotExistException if note does not exist
     * @return boolean the new favorite state of the note
     */
    public function favorite ($id, $favorite, $userId){
        $folder = $this->getFolderForUser($userId);
        $file = $this->getFileById($folder, $id);
        if(!$this->isNote($file)) {
            throw new NoteDoesNotExistException();
        }
        $tagger = \OC::$server->getTagManager()->load('files');
        if($favorite)
            $tagger->addToFavorites($id);
        else
            $tagger->removeFromFavorites($id);

        $tags = $tagger->getTagsForObjects([$id]);
        return in_array(\OC\Tags::TAG_FAVORITE, $tags[$id]);
    }


    /**
     * Deletes a note
     * @param int $id the id of the note which should be deleted
     * @param string $userId
     * @throws NoteDoesNotExistException if note does not
     * exist
     */
    public function delete ($id, $userId) {
        $folder = $this->getFolderForUser($userId);
        $file = $this->getFileById($folder, $id);
        $file->delete();
    }


    /**
     * @param Folder $folder
     * @param int $id
     * @throws NoteDoesNotExistException
     * @return \OCP\Files\File
     */
    private function getFileById ($folder, $id) {
        $file = $folder->getById($id);

        if(count($file) <= 0 || !$this->isNote($file[0])) {
            throw new NoteDoesNotExistException();
        }
        $tagger = \OC::$server->getTagManager()->load('files');
        $tags = $tagger->getTagsForObjects([$id]);
        if ($tags) {
            $file[0]->getFileInfo()->offsetSet('tags', $tags[$id]);
        }
        return $file[0];
    }


    /**
     * @param string $userId the user id
     * @return Folder
     */
    private function getFolderForUser ($userId) {
        $path = '/' . $userId . '/files/Notes';
        if ($this->root->nodeExists($path)) {
            $folder = $this->root->get($path);
        } else {
            $folder = $this->root->newFolder($path);
        }
        return $folder;
    }


    /**
     * 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 $extension the extension 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
     */
    private function generateFileName (Folder $folder, $title, $extension, $id) {
        $path = $title . '.' . $extension;

        // 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+)\)$/', $title, $matches);
            if($match) {
                $newId = ((int) $matches['id']) + 1;
                $newTitle = preg_replace('/(.*)\s\((\d+)\)$/',
                    '$1 (' . $newId . ')', $title);
            } else {
                $newTitle = $title . ' (2)';
            }
            return $this->generateFileName($folder, $newTitle, $extension, $id);
        }
    }

    /**
     * test if file is a note
     *
     * @param \OCP\Files\File $file
     * @return bool
     */
    private function isNote($file) {
        $allowedExtensions = ['txt', 'org', 'markdown', 'md', 'note'];

        if($file->getType() !== 'file') return false;
        if(!in_array(
            pathinfo($file->getName(), PATHINFO_EXTENSION),
            $allowedExtensions
        )) return false;

        return true;
    }

}


1		<?php
2		/**
3		* ownCloud - Notes
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Bernhard Posselt <[email protected]>
9		* @copyright Bernhard Posselt 2012, 2014
10		*/
11
12		namespace OCA\Notes\Service;
13
14		use OCP\IL10N;
15		use OCP\Files\IRootFolder;
16		use OCP\Files\Folder;
17
18		use OCA\Notes\Db\Note;
19
20		/**
21		* Class NotesService
22		*
23		* @package OCA\Notes\Service
24		*/
25		class NotesService {
26
27		private $l10n;
28		private $root;
29
30		/**
31		* @param IRootFolder $root
32		* @param IL10N $l10n
33		*/
34	11	public function __construct (IRootFolder $root, IL10N $l10n) {
35	11	$this->root = $root;
36	11	$this->l10n = $l10n;
37	11	}
38
39
40		/**
41		* @param string $userId
42		* @return array with all notes in the current directory
43		*/
44	1	public function getAll ($userId){
45	1	$folder = $this->getFolderForUser($userId);
46	1	$files = $folder->getDirectoryListing();
47	1	$filesById = [];
48		foreach($files as $file) {
49	1	if($this->isNote($file)) {
50	1	$filesById[$file->getId()] = $file;
51	1	}
52	1	}
53	1	$tagger = \OC::$server->getTagManager()->load('files');
54		$tags = $tagger->getTagsForObjects(array_keys($filesById));
55	1	if ($tags) {
56		foreach ($tags as $fileId => $fileTags) {
57		$filesById[$fileId]->getFileInfo()->offsetSet('tags', $fileTags);
58		}
59		}
60
61		$notes = [];
62		foreach($filesById as $file) {
63		$notes[] = Note::fromFile($file);
64		}
65
66	3	return $notes;
67	3	}
68	3
69
70		/**
71		* Used to get a single note by id
72		* @param int $id the id of the note to get
73		* @param string $userId
74		* @throws NoteDoesNotExistException if note does not exist
75		* @return Note
76		*/
77		public function get ($id, $userId) {
78	2	$folder = $this->getFolderForUser($userId);
79	2	return Note::fromFile($this->getFileById($folder, $id));
80	2	}
81
82
83		/**
84		* Creates a note and returns the empty note
85	2	* @param string $userId
86	2	* @see update for setting note content
87		* @return Note the newly created note
88	2	*/
89		public function create ($userId) {
90		$title = $this->l10n->t('New note');
91		$folder = $this->getFolderForUser($userId);
92
93		// check new note exists already and we need to number it
94		// pass -1 because no file has id -1 and that will ensure
95		// to only return filenames that dont yet exist
96		$path = $this->generateFileName($folder, $title, "txt", -1);
97		$file = $folder->newFile($path);
98
99		return Note::fromFile($file);
100		}
101	2
102	2
103	2	/**
104		* Updates a note. Be sure to check the returned note since the title is
105		* dynamically generated and filename conflicts are resolved
106	2	* @param int $id the id of the note used to update
107	2	* @param string $content the content which will be written into the note
108		* the title is generated from the first line of the content
109	2	* @throws NoteDoesNotExistException if note does not exist
110	1	* @return \OCA\Notes\Db\Note the updated note
111	1	*/
112		public function update ($id, $content, $userId){
113		$folder = $this->getFolderForUser($userId);
114	2	$file = $this->getFileById($folder, $id);
115
116		// generate content from the first line of the title
117	2	$splitContent = explode("\n", $content);
118		$title = $splitContent[0];
119	2
120		if(!$title) {
121		$title = $this->l10n->t('New note');
122	2	}
123	2
124	2	// prevent directory traversal
125	2	$title = str_replace(array('/', '\\'), '', $title);
126		// remove hash and space characters from the beginning of the filename
127		// in case of markdown
128	2	$title = ltrim($title, ' #');
129	2	// using a maximum of 100 chars should be enough
130	2	$title = mb_substr($title, 0, 100, "UTF-8");
131
132	2	// generate filename if there were collisions
133		$currentFilePath = $file->getPath();
134	2	$basePath = '/' . $userId . '/files/Notes/';
135		$fileExtension = pathinfo($file->getName(), PATHINFO_EXTENSION);
136		$newFilePath = $basePath . $this->generateFileName($folder, $title, $fileExtension, $id);
137
138		// if the current path is not the new path, the file has to be renamed
139		if($currentFilePath !== $newFilePath) {
140		$file->move($newFilePath);
141		}
142
143		$file->putContent($content);
144
145	3	return Note::fromFile($file);
146	3	}
147	3
148	1
149	1	/**
150		* Set or unset a note as favorite.
151		* @param int $id the id of the note used to update
152		* @param boolean $favorite whether the note should be a favorite or not
153		* @throws NoteDoesNotExistException if note does not exist
154		* @return boolean the new favorite state of the note
155		*/
156		public function favorite ($id, $favorite, $userId){
157		$folder = $this->getFolderForUser($userId);
158	8	$file = $this->getFileById($folder, $id);
159	8	if(!$this->isNote($file)) {
160		throw new NoteDoesNotExistException();
161	8	}
162	4	$tagger = \OC::$server->getTagManager()->load('files');
163		if($favorite)
164		$tagger->addToFavorites($id);
165	4	else
166		$tagger->removeFromFavorites($id);
167
168		$tags = $tagger->getTagsForObjects([$id]);
169		return in_array(\OC\Tags::TAG_FAVORITE, $tags[$id]);
170		}
171
172
173	11	/**
174	11	* Deletes a note
175	11	* @param int $id the id of the note which should be deleted
176	11	* @param string $userId
177	11	* @throws NoteDoesNotExistException if note does not
178		* exist
179		*/
180	11	public function delete ($id, $userId) {
181		$folder = $this->getFolderForUser($userId);
182		$file = $this->getFileById($folder, $id);
183		$file->delete();
184		}
185
186
187		/**
188		* @param Folder $folder
189		* @param int $id
190		* @throws NoteDoesNotExistException
191		* @return \OCP\Files\File
192		*/
193		private function getFileById ($folder, $id) {
194		$file = $folder->getById($id);
195
196		if(count($file) <= 0 \|\| !$this->isNote($file[0])) {
197	4	throw new NoteDoesNotExistException();
198	4	}
199		$tagger = \OC::$server->getTagManager()->load('files');
200		$tags = $tagger->getTagsForObjects([$id]);
201		if ($tags) {
202	4	$file[0]->getFileInfo()->offsetSet('tags', $tags[$id]);
203	4	}
204		return $file[0];
205		}
206	3
207	3
208	3	/**
209	3	* @param string $userId the user id
210	3	* @return Folder
211	3	*/
212	3	private function getFolderForUser ($userId) {
213		$path = '/' . $userId . '/files/Notes';
214	3	if ($this->root->nodeExists($path)) {
215		$folder = $this->root->get($path);
216		} else {
217		$folder = $this->root->newFolder($path);
218		}
219		return $folder;
220		}
221
222
223		/**
224	7	* get path of file and the title.txt and check if they are the same
225	7	* file. If not the title needs to be renamed
226		*
227	7	* @param Folder $folder a folder to the notes directory
228	7	* @param string $title the filename which should be used
229	7	* @param string $extension the extension which should be used
230		* @param int $id the id of the note for which the title should be generated
231	7	* used to see if the file itself has the title and not a different file for
232		* checking for filename collisions
233	5	* @return string the resolved filename to prevent overwriting different
234		* files with the same title
235		*/
236		private function generateFileName (Folder $folder, $title, $extension, $id) {
237		$path = $title . '.' . $extension;
238
239		// if file does not exist, that name has not been taken. Similar we don't
240		// need to handle file collisions if it is the filename did not change
241		if (!$folder->nodeExists($path) \|\| $folder->get($path)->getId() === $id) {
242		return $path;
243		} else {
244		// increments name (2) to name (3)
245		$match = preg_match('/\((?P<id>\d+)\)$/', $title, $matches);
246		if($match) {
247		$newId = ((int) $matches['id']) + 1;
248		$newTitle = preg_replace('/(.*)\s\((\d+)\)$/',
249		'$1 (' . $newId . ')', $title);
250		} else {
251		$newTitle = $title . ' (2)';
252		}
253		return $this->generateFileName($folder, $newTitle, $extension, $id);
254		}
255		}
256
257		/**
258		* test if file is a note
259		*
260		* @param \OCP\Files\File $file
261		* @return bool
262		*/
263		private function isNote($file) {
264		$allowedExtensions = ['txt', 'org', 'markdown', 'md', 'note'];
265
266		if($file->getType() !== 'file') return false;
267		if(!in_array(
268		pathinfo($file->getName(), PATHINFO_EXTENSION),
269		$allowedExtensions
270		)) return false;
271
272		return true;
273		}
274
275		}
276

owncloud / notes

Pull Request — master (#248)

NotesService::getAll() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like