brantje / nextnote

lib/backend.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 35 and the first side effect is on line 26.

/**
 * Nextcloud - ownnote
 *
 * @copyright Copyright (c) 2015, Ben Curtis <ownclouddev@nosolutions.com>
 * @copyright Copyright (c) 2017, Sander Brand (brantje@gmail.com)
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\OwnNote\Lib;

\OCP\User::checkLoggedIn();

use DateTime;
use DOMDocument;
use OC\Files\Filesystem;
use OCA\Admin_Audit\Actions\UserManagement;
use OCP\IConfig;
use OCP\IL10N;

class Backend {


	private $db;
	private $config;

	/**
	 * Backend constructor.
	 *
	 * @param $userManager \OC\User\Manager
	 * @param IConfig $config
	 */
	public function __construct(IConfig $config) {
		$this->db = \OC::$server->getDatabaseConnection();
		$this->config = $config;
	}

	/**
	 * @param $haystack
	 * @param $needle
	 * @return bool
	 */
	public function startsWith($haystack, $needle) {
		return $needle === "" || strripos($haystack, $needle, -strlen($haystack)) !== false;
	}

	/**
	 * @param $string
	 * @param $test
	 * @return bool
	 */
	public function endsWith($string, $test) {

This method seems to be duplicated in your project.

		$strlen = strlen($string);
		$testlen = strlen($test);
		if ($testlen > $strlen) return false;
		return substr_compare($string, $test, $strlen - $testlen, $testlen, true) === 0;
	}

	/**
	 * @param $folder
	 * @param $file
	 */
	public function checkEvernote($folder, $file) {
		$html = "";
		if ($html = Filesystem::file_get_contents($folder . "/" . $file)) {
			$DOM = new DOMDocument;
			$DOM->loadHTML($html);
			$items = $DOM->getElementsByTagName('meta');
			$isEvernote = false;
			for ($i = 0; $i < $items->length; $i++) {

This code seems to be duplicated across your project.

				$item = $items->item($i);
				if ($item->hasAttributes()) {
					$attrs = $item->attributes;
					foreach ($attrs as $a => $attr) {
						if ($attr->name == "name") {
							if ($attr->value == "exporter-version" || $attr->value == "Generator") {
								$isEvernote = true;
								continue;
							}
						}
					}
				}
			}
			if ($isEvernote) {
				$items = $DOM->getElementsByTagName('img');
				$isEvernote = false;
				for ($i = 0; $i < $items->length; $i++) {
					$item = $items->item($i);
					if ($item->hasAttributes()) {
						$attrs = $item->attributes;
						foreach ($attrs as $a => $attr) {
							if ($attr->name == "src") {
								$url = $attr->value;
								if (!$this->startsWith($url, "http") && !$this->startsWith($url, "/") && !$this->startsWith($url, "data")) {
									if ($data = Filesystem::file_get_contents($folder . "/" . $url)) {

This code seems to be duplicated across your project.

										$type = pathinfo($url, PATHINFO_EXTENSION);
										$base64 = "data:image/" . $type . ";base64," . base64_encode($data);
										$html = str_replace($url, $base64, $html);
									}
								}
							}
						}
					}
				}
				Filesystem::file_put_contents($folder . "/" . $file, $html);
			}
		}
	}

	/**
	 * @param $filetime DateTime
	 * @param $now DateTime
	 * @param $l IL10N
	 * @return mixed|string
	 */
	public function getTimeString($filetime, $now, $l) {

This method seems to be duplicated in your project.

		$difftime = $filetime->diff($now);
		$years = $difftime->y;
		$months = $difftime->m;
		$days = $difftime->d;
		$hours = $difftime->h;
		$minutes = $difftime->i;
		$seconds = $difftime->s;
		$timestring = "";
		if ($timestring == "" && $years == 1) $timestring = str_replace('#', $years, $l->t("# year ago"));
		if ($timestring == "" && $years > 0) $timestring = str_replace('#', $years, $l->t("# years ago"));
		if ($timestring == "" && $months == 1) $timestring = str_replace('#', $months, $l->t("# month ago"));
		if ($timestring == "" && $months > 0) $timestring = str_replace('#', $months, $l->t("# months ago"));
		if ($timestring == "" && $days == 1) $timestring = str_replace('#', $days, $l->t("# day ago"));
		if ($timestring == "" && $days > 0) $timestring = str_replace('#', $days, $l->t("# days ago"));
		if ($timestring == "" && $hours == 1) $timestring = str_replace('#', $hours, $l->t("# hour ago"));
		if ($timestring == "" && $hours > 0) $timestring = str_replace('#', $hours, $l->t("# hours ago"));
		if ($timestring == "" && $minutes == 1) $timestring = str_replace('#', $minutes, $l->t("# minute ago"));
		if ($timestring == "" && $minutes > 0) $timestring = str_replace('#', $minutes, $l->t("# minutes ago"));
		if ($timestring == "" && $seconds == 1) $timestring = str_replace('#', $seconds, $l->t("# second ago"));
		if ($timestring == "" && $seconds > 0) $timestring = str_replace('#', $seconds, $l->t("# seconds ago"));
		return $timestring;
	}

	/**
	 * @param $str
	 * @return array
	 */
	public function splitContent($str) {

This method seems to be duplicated in your project.

		$maxlength = 2621440; // 5 Megs (2 bytes per character)
		$count = 0;
		$strarray = array();
		while (true) {
			if (strlen($str) <= $maxlength) {
				$strarray[$count++] = $str;
				return $strarray;
			} else {
				$strarray[$count++] = substr($str, 0, $maxlength);
				$str = substr($str, $maxlength);
			}
		}
		return $strarray;
	}

	/**
	 * Returns a user's owned and shared notes
	 *
	 * @param string $uid the user's id
	 * @return array the owned notes (uid=uid) and shared notes (OwnnoteShareBackend)
	 */
	private function queryNotesWithUser($uid) {
		// Get owned notes

		$query = $this->db->executeQuery("SELECT id, uid, name, grouping, mtime, deleted FROM *PREFIX*ownnote WHERE uid=? ORDER BY name", Array($uid));
		$results = $query->fetchAll();
		// Get shares
		$shared_items = \OCP\Share::getItemsSharedWith('ownnote', 'populated_shares');

		return array_merge($results, $shared_items);
	}

	/**
	 * @param $FOLDER
	 * @param $showdel
	 * @return array
	 */
	public function getListing($FOLDER, $showdel) {
		// Get the listing from the database
		$requery = false;
		$uid = \OC::$server->getUserSession()->getUser()->getUID();
		$results = $this->queryNotesWithUser($uid);

		$results2 = $results;
		if ($results)
			foreach ($results as $result) {
				foreach ($results2 as $result2) {
					if ($result['id'] != $result2['id'] && $result['name'] == $result2['name'] && $result['grouping'] == $result2['grouping']) {

This code seems to be duplicated across your project.

						// We have a duplicate that should not exist. Need to remove the offending record first
						$delid = -1;
						if ($result['mtime'] == $result2['mtime']) {
							// If the mtime's match, delete the oldest ID.
							$delid = $result['id'];
							if ($result['id'] > $result2['id'])
								$delid = $result2['id'];
						} elseif ($result['mtime'] > $result2['mtime']) {
							// Again, delete the oldest
							$delid = $result2['id'];
						} elseif ($result['mtime'] < $result2['mtime']) {
							// The only thing left is if result is older
							$delid = $result['id'];
						}
						if ($delid != -1) {
							$this->db->executeQuery("DELETE FROM *PREFIX*ownnote WHERE id=?", Array($delid));
							$requery = true;
						}
					}
				}
			}
		if ($requery) {
			$results = $this->queryNotesWithUser($uid);
			$requery = false;
		}
		// Tests to add a bunch of notes
		//$now = new DateTime();
		//for ($x = 0; $x < 199; $x++) {
		//saveNote('', "Test ".$x, '', '', $now->getTimestamp());
		//}
		$farray = array();
		if ($FOLDER != '') {
			// Create the folder if it doesn't exist
			if (!Filesystem::is_dir($FOLDER)) {

This code seems to be duplicated across your project.

				if (!Filesystem::mkdir($FOLDER)) {
					\OCP\Util::writeLog('ownnote', 'Could not create ownNote directory.', \OCP\Util::ERROR);
					exit;
				}
			}
			// Synchronize files to the database
			$filearr = array();
			if ($listing = Filesystem::opendir($FOLDER)) {
				if (!$listing) {
					\OCP\Util::writeLog('ownnote', 'Error listing directory.', \OCP\Util::ERROR);
					exit;
				}
				while (($file = readdir($listing)) !== false) {
					$tmpfile = $file;
					if ($tmpfile == "." || $tmpfile == "..") continue;
					if (!$this->endsWith($tmpfile, ".htm") && !$this->endsWith($tmpfile, ".html")) continue;
					if ($info = Filesystem::getFileInfo($FOLDER . "/" . $tmpfile)) {
						// Check for EVERNOTE but wait to rename them to get around:
						// https://github.com/owncloud/core/issues/16202
						if ($this->endsWith($tmpfile, ".html")) {
							$this->checkEvernote($FOLDER, $tmpfile);
						}
						// Separate the name and group name
						$name = preg_replace('/\\.[^.\\s]{3,4}$/', '', $tmpfile);
						$group = "";
						if (substr($name, 0, 1) == "[") {

This code seems to be duplicated across your project.

							$end = strpos($name, ']');
							$group = substr($name, 1, $end - 1);
							$name = substr($name, $end + 1, strlen($name) - $end + 1);
							$name = trim($name);
						}
						// Set array for later checking
						$filearr[] = $tmpfile;
						// Check to see if the file is in the DB
						$fileindb = false;
						if ($results)
							foreach ($results as $result) {
								if ($result['deleted'] == 0)
									if ($name == $result['name'] && $group == $result['grouping']) {
										$fileindb = true;
										// If it is in the DB, check if the filesystem file is newer than the DB
										if ($result['mtime'] < $info['mtime']) {
											// File is newer, this could happen if a user updates a file
											$html = "";
											$html = Filesystem::file_get_contents($FOLDER . "/" . $tmpfile);
											$this->saveNote('', $result['id'], $html, $info['mtime']);
											$requery = true;
										}
									}
							}
						if (!$fileindb) {
							// If it's not in the DB, add it.
							$html = "";
							if ($html = Filesystem::file_get_contents($FOLDER . "/" . $tmpfile)) {
							} else {
								$html = "";
							}
							$nid = $this->createNote('', $name, $group);
							$this->saveNote('', $nid, $html, $info['mtime']);
							$requery = true;
						}
						// We moved the rename down here to overcome the OC issue
						if ($this->endsWith($tmpfile, ".html")) {

This code seems to be duplicated across your project.

							$tmpfile = substr($tmpfile, 0, -1);
							if (!Filesystem::file_exists($FOLDER . "/" . $tmpfile)) {
								Filesystem::rename($FOLDER . "/" . $file, $FOLDER . "/" . $tmpfile);
							}
						}
					}
				}
			}
			if ($requery) {
				$results = $this->queryNotesWithUser($uid);
			}
			// Now also make sure the files exist, they may not if the user switched folders in admin.
			if ($results)
				foreach ($results as $result) {
					if ($result['deleted'] == 0) {
						$tmpfile = $result['name'] . ".htm";
						if ($result['grouping'] != '')

This code seems to be duplicated across your project.

							$tmpfile = '[' . $result['grouping'] . '] ' . $result['name'] . '.htm';
						$filefound = false;
						foreach ($filearr as $f) {
							if ($f == $tmpfile) {
								$filefound = true;
								break;
							}
						}
						if (!$filefound) {
							$content = $this->editNote($result['id']);
							$this->saveNote($FOLDER,$result['id'], $content, 0);
						}
					}
				}
		}
		// Now loop through and return the listing
		if ($results) {
			$count = 0;
			$now = new DateTime();
			$filetime = new DateTime();
			$l = \OCP\Util::getL10N('ownnote');
			foreach ($results as $result) {
				if ($result['deleted'] == 0 || $showdel == true) {
					$filetime->setTimestamp($result['mtime']);
					$timestring = $this->getTimeString($filetime, $now, $l);
					$f = array();
					$f['id'] = $result['id'];
					$f['uid'] = $result['uid'];
					$f['name'] = $result['name'];
					$f['group'] = $result['grouping'];
					$f['timestring'] = $timestring;
					$f['mtime'] = $result['mtime'];
					$f['timediff'] = $now->getTimestamp() - $result['mtime'];
					$f['deleted'] = $result['deleted'];


					$shared_with = \OCP\Share::getUsersItemShared('ownnote', $result['id'], $result['uid']);
					// add shares (all shares, if it's an owned note, only the user for shared notes (not disclosing other sharees))
					$f['shared_with'] = ($result['uid'] == $uid) ? $shared_with : [$uid];

					$farray[$count] = $f;
					$count++;
				}
			}
		}
		return $farray;
	}

	/**
	 * @param $FOLDER
	 * @param $in_name
	 * @param $in_group
	 * @return int
	 */
	public function createNote($FOLDER, $in_name, $in_group) {
		$name = str_replace("\\", "-", str_replace("/", "-", $in_name));
		$group = str_replace("\\", "-", str_replace("/", "-", $in_group));
		$now = new DateTime();
		$mtime = $now->getTimestamp();
		$uid = \OC::$server->getUserSession()->getUser()->getUID();
		$fileindb = false;
		$filedeldb = false;
		$ret = -1;
		$query = $this->db->executeQuery("SELECT id, uid, name, grouping, mtime, deleted FROM *PREFIX*ownnote WHERE name=? and grouping=? and uid=?", Array($name, $group, $uid));
		$results = $query->fetchAll();
		foreach ($results as $result) {
			if ($result['deleted'] == 0) {
				$fileindb = true;
				$ret = $result['id'];
			} else {
				$filedeldb = true;
			}
		}
		if ($filedeldb) {
			$this->db->executeQuery("DELETE FROM *PREFIX*ownnote WHERE name=? and grouping=? and uid=?", Array($name, $group, $uid));
		}
		// new note
		if (!$fileindb) {
			if ($FOLDER != '') {
				$tmpfile = $FOLDER . "/" . $name . ".htm";
				if ($group != '')
					$tmpfile = $FOLDER . "/[" . $group . "] " . $name . ".htm";
				if (!Filesystem::file_exists($tmpfile)) {
					Filesystem::touch($tmpfile);
				}
				if ($info = Filesystem::getFileInfo($tmpfile)) {
					$mtime = $info['mtime'];
				}
			}
			$this->db->executeQuery("INSERT INTO *PREFIX*ownnote (uid, name, grouping, mtime, note, shared) VALUES (?,?,?,?,?,?)", Array($uid, $name, $group, $mtime, '', ''));
			$ret = $this->db->lastInsertId('*PREFIX*ownnote');
		}
		return $ret;
	}

	/**
	 * @param $FOLDER
	 * @param $nid
	 * @return bool
	 */
	public function deleteNote($FOLDER, $nid) {
		if (!$this->checkPermissions(\OCP\Constants::PERMISSION_DELETE, $nid)) {
			return false;
		}

		$now = new DateTime();
		$mtime = $now->getTimestamp();
		$uid = \OC::$server->getUserSession()->getUser()->getUID();

$uid is not used, you could remove the assignment.

		$note = $this->getNote($nid);
		$name = $note['name'];
		$group = $note['group'];
		$this->db->executeQuery("UPDATE *PREFIX*ownnote set note='', deleted=1, mtime=? WHERE id=?", Array($mtime, $nid));
		//$results = $query->fetchAll();

		$this->db->executeQuery("DELETE FROM *PREFIX*ownnote_parts WHERE id=?", Array($nid));

		if ($FOLDER != '') {

This code seems to be duplicated across your project.

			$tmpfile = $FOLDER . "/" . $name . ".htm";
			if ($group != '')
				$tmpfile = $FOLDER . "/[" . $group . "] " . $name . ".htm";
			if (Filesystem::file_exists($tmpfile))
				Filesystem::unlink($tmpfile);
		}
		return true;
	}

	/**
	 * @param $id
	 * @return string
	 */
	public function editNote($id) {
		$retVal = "";
		$note = $this->getNote($id);

		// query parts
		$query = $this->db->executeQuery("SELECT note FROM *PREFIX*ownnote_parts WHERE id=? order by pid", Array($note['id']));
		$results = $query->fetchAll();
		foreach ($results as $result) {
			$retVal .= $result['note'];
		}

		return $retVal;
	}

	/**
	 * @param $FOLDER
	 * @param $nid
	 * @param $content
	 * @param $in_mtime
	 * @return bool
	 */
	public function saveNote($FOLDER, $nid, $content, $in_mtime) {
		$maxlength = 2621440; // 5 Megs (2 bytes per character)
		$now = new DateTime();
		$mtime = $now->getTimestamp();
		if ($in_mtime != 0) {
			$mtime = $in_mtime;
		}

		// get the specific note
		$note = $this->getNote($nid);
		$name = $note['name'];
		$group = $note['grouping'];

		if ($FOLDER != '') {
			$tmpfile = $FOLDER . "/" . $name . ".htm";
			if ($group != '')
				$tmpfile = $FOLDER . "/[" . $group . "] " . $name . ".htm";
			Filesystem::file_put_contents($tmpfile, $content);
			if ($info = Filesystem::getFileInfo($tmpfile)) {
				$mtime = $info['mtime'];
			}
		}
		$this->db->executeQuery("UPDATE *PREFIX*ownnote set note='', mtime=? WHERE id=?", Array($mtime, $note['id']));

		$this->db->executeQuery("DELETE FROM *PREFIX*ownnote_parts WHERE id=?", Array($note['id']));
		$contentarr = $this->splitContent($content);
		for ($i = 0; $i < count($contentarr); $i++) {
			$this->db->executeQuery("INSERT INTO *PREFIX*ownnote_parts (id, note) values (?,?)", Array($note['id'], $contentarr[$i]));
		}
		return true;
	}

	/**
	 * @param $FOLDER
	 * @param $id
	 * @param $in_newname
	 * @param $in_newgroup
	 * @return bool
	 */
	public function renameNote($FOLDER, $id, $in_newname, $in_newgroup) {
		$newname = str_replace("\\", "-", str_replace("/", "-", $in_newname));
		$newgroup = str_replace("\\", "-", str_replace("/", "-", $in_newgroup));

		// We actually need to delete and create so that the delete flag exists for syncing clients
		$content = $this->editNote($id);
		$this->deleteNote($FOLDER, $id);

		$newId = $this->createNote($FOLDER, $newname, $newgroup);
		$this->saveNote($FOLDER, $newId, $content, 0);

		return true;
	}

	/**
	 * @param $FOLDER
	 * @param $group
	 * @return bool
	 */
	public function deleteGroup($FOLDER, $group) {
		// We actually need to just rename all the notes
		$uid = \OC::$server->getUserSession()->getUser()->getUID();
		$query = $this->db->executeQuery("SELECT id, name, grouping, mtime FROM *PREFIX*ownnote WHERE deleted=0 and uid=? and grouping=?", Array($uid, $group));
		$results = $query->fetchAll();
		foreach ($results as $result) {
			$this->renameNote($FOLDER, $result['id'], $result['name'], '');
		}
		return true;
	}

	/**
	 * @param $FOLDER
	 * @param $group
	 * @param $newgroup
	 * @return bool
	 */
	public function renameGroup($FOLDER, $group, $newgroup) {
		$uid = \OC::$server->getUserSession()->getUser()->getUID();
		$query = $this->db->executeQuery("SELECT id, name, grouping, mtime FROM *PREFIX*ownnote WHERE deleted=0 and uid=? and grouping=?", Array($uid, $group));
		$results = $query->fetchAll();
		foreach ($results as $result) {
			$this->renameNote($FOLDER, $result['id'], $result['name'], $newgroup);
		}
		return true;
	}

	/**
	 * @return string
	 */
	public function getVersion() {
		$v = file_get_contents(__DIR__ . "/../appinfo/version");
		if ($v)
			return trim($v);
		else
			return "";
	}

	/**
	 * @param $option
	 * @param $value
	 */
	public function setAdminVal($option, $value) {
		$this->config->setAppValue('ownnote', $option, $value);
		return true;
	}

	/**
	 * @param $noteid
	 * @return mixed
	 */
	private function getNote($noteid) {
		$query = $this->db->executeQuery("SELECT id, uid, name, grouping, mtime, note, deleted FROM *PREFIX*ownnote WHERE id=?", Array($noteid));
		$result = array_shift($query->fetchAll());
		return $result;
	}

	/**
	 * @param $permission
	 * @param $nid
	 * @return bool|int
	 */
	private function checkPermissions($permission, $nid) {

This method seems to be duplicated in your project.

		// gather information
		$uid = \OC::$server->getUserSession()->getUser()->getUID();
		$note = $this->getNote($nid);
		// owner is allowed to change everything
		if ($uid === $note['uid']) {
			return true;
		}

		// check share permissions
		$shared_note = \OCP\Share::getItemSharedWith('ownnote', $nid, 'populated_shares')[0];
		return $shared_note['permissions'] & $permission;
	}
}

?>