X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FModel%2FFileTag.php;h=a2c8bb43972a426e9647d7a5866915a2acd5d247;hb=3a4be3d5f468d5bedb56199becdaba87fd543f94;hp=4ba4e3ca7c18299ac9effa73a20882a9a26eb7a5;hpb=57695d48b41b5dba9a4ec1e97b531ff6590d8845;p=friendica.git

diff --git a/src/Model/FileTag.php b/src/Model/FileTag.php
index 4ba4e3ca7c..a2c8bb4397 100644
--- a/src/Model/FileTag.php
+++ b/src/Model/FileTag.php
@@ -1,312 +1,321 @@
 <?php
 /**
- * @file src/Model/FileTag.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
  */
 
 namespace Friendica\Model;
 
-use Friendica\Core\L10n;
-use Friendica\Core\PConfig;
 use Friendica\Database\DBA;
-use Friendica\Model\Item;
+use Friendica\DI;
+use Friendica\Model\Post\Category;
 
 /**
- * @brief This class handles FileTag related functions
+ * This class handles FileTag related functions
+ *
+ * post categories and "save to file" use the same item.file table for storage.
+ * We will differentiate the different uses by wrapping categories in angle brackets
+ * and save to file categories in square brackets.
+ * To do this we need to escape these characters if they appear in our tag.
  */
 class FileTag
 {
-    // post categories and "save to file" use the same item.file table for storage.
-    // We will differentiate the different uses by wrapping categories in angle brackets
-    // and save to file categories in square brackets.
-    // To do this we need to escape these characters if they appear in our tag.
-
-    /**
-     * @brief URL encode &lt, &gt, left and right brackets
-     * 
-     * @param string $s String to be URL encoded.
-     * 
-     * @return string   The URL encoded string.
-     */
-    public static function encode($s)
-    {
-        return str_replace(['<', '>', '[', ']'], ['%3c', '%3e', '%5b', '%5d'], $s);
-    }
-
-    /**
-     * @brief URL decode &lt, &gt, left and right brackets
-     * 
-     * @param string $s The URL encoded string to be decoded
-     * 
-     * @return string   The decoded string.
-     */
-    public static function decode($s)
-    {
-        return str_replace(['%3c', '%3e', '%5b', '%5d'], ['<', '>', '[', ']'], $s);
-    }
-
-    /**
-     * @brief Query files for tag
-     * 
-     * @param string $table The table to be queired.
-     * @param string $s     The search term
-     * @param string $type  Optional file type.
-     * 
-     * @return string       Query string.
-     */
-    public static function fileQuery($table, $s, $type = 'file')
-    {
-        if ($type == 'file') {
-            $str = preg_quote('[' . str_replace('%', '%%', self::encode($s)) . ']');
-        } else {
-            $str = preg_quote('<' . str_replace('%', '%%', self::encode($s)) . '>');
-        }
-
-        return " AND " . (($table) ? DBA::escape($table) . '.' : '') . "file regexp '" . DBA::escape($str) . "' ";
-    }
-
-    /**
-     * @brief Get file tags from list
-     * 
-     * ex. given music,video return <music><video> or [music][video]
-     * @param string $list  A comma delimited list of tags.
-     * @param string $type  Optional file type.
-     * 
-     * @return string       A list of file tags.
-     */
-    public static function listToFile($list, $type = 'file')
-    {
-        $tag_list = '';
-        if (strlen($list)) {
-            $list_array = explode(",", $list);
-            if ($type == 'file') {
-                $lbracket = '[';
-                $rbracket = ']';
-            } else {
-                $lbracket = '<';
-                $rbracket = '>';
-            }
-
-            foreach ($list_array as $item)
-            {
-                if (strlen($item))
-                {
-                    $tag_list .= $lbracket . self::encode(trim($item))  . $rbracket;
-                }
-            }
-        }
-
-        return $tag_list;
-    }
-
-    /**
-     * @brief Get list from file tags
-     * 
-     * ex. given <music><video>[friends], return music,video or friends
-     * @param string $file  File tags
-     * @param string $type  Optional file type.
-     * 
-     * @return string       Comma delimited list of tag names.
-     */
-    public static function fileToList($file, $type = 'file')
-    {
-        $matches = false;
-        $list = '';
-
-        if ($type == 'file') {
-            $cnt = preg_match_all('/\[(.*?)\]/', $file, $matches, PREG_SET_ORDER);
-        } else {
-            $cnt = preg_match_all('/<(.*?)>/', $file, $matches, PREG_SET_ORDER);
-        }
-
-        if ($cnt)
-        {
-            foreach ($matches as $mtch)
-            {
-                if (strlen($list))
-                {
-                    $list .= ',';
-                }
-
-                $list .= self::decode($mtch[1]);
-            }
-        }
-
-        return $list;
-    }
-
-    /**
-     * @brief Update file tags in PConfig
-     * 
-     * @param int $uid          Unique Identity.
-     * @param string $file_old  Categories previously associated with an item
-     * @param string $file_new  New list of categories for an item
-     * @param string $type      Optional file type.
-     * 
-     * @return boolean          A value indicating success or failure.
-     */
-    public static function updatePconfig($uid, $file_old, $file_new, $type = 'file')
-    {
-        if (!intval($uid)) {
-            return false;
-        } elseif ($file_old == $file_new) {
-            return true;
-        }
-
-        $saved = PConfig::get($uid, 'system', 'filetags');
-
-        if (strlen($saved))
-        {
-            if ($type == 'file') {
-                $lbracket = '[';
-                $rbracket = ']';
-                $termtype = TERM_FILE;
-            } else {
-                $lbracket = '<';
-                $rbracket = '>';
-                $termtype = TERM_CATEGORY;
-            }
-
-            $filetags_updated = $saved;
-
-            // check for new tags to be added as filetags in pconfig
-            $new_tags = [];
-            $check_new_tags = explode(",", self::fileToList($file_new, $type));
-
-            foreach ($check_new_tags as $tag)
-            {
-                if (!stristr($saved,$lbracket . self::encode($tag) . $rbracket)) {
-                    $new_tags[] = $tag;
-                }
-            }
-
-            $filetags_updated .= self::listToFile(implode(",", $new_tags), $type);
-
-            // check for deleted tags to be removed from filetags in pconfig
-            $deleted_tags = [];
-            $check_deleted_tags = explode(",", self::fileToList($file_old, $type));
-
-            foreach ($check_deleted_tags as $tag)
-            {
-                if (!stristr($file_new,$lbracket . self::encode($tag) . $rbracket)) {
-                    $deleted_tags[] = $tag;
-                }
-            }
-
-            foreach ($deleted_tags as $key => $tag)
-            {
-                $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
-                    DBA::escape($tag),
-                    intval(TERM_OBJ_POST),
-                    intval($termtype),
-                    intval($uid));
-
-                if (DBA::isResult($r)) {
-                    unset($deleted_tags[$key]);
-                } else {
-                    $filetags_updated = str_replace($lbracket . self::encode($tag) . $rbracket, '', $filetags_updated);
-                }
-            }
-
-            if ($saved != $filetags_updated)
-            {
-                PConfig::set($uid, 'system', 'filetags', $filetags_updated);
-            }
-
-            return true;
-        } elseif (strlen($file_new)) {
-            PConfig::set($uid, 'system', 'filetags', $file_new);
-        }
-
-        return true;
-    }
-
-    /**
-     * @brief Add tag to file
-     * 
-     * @param int $uid      Unique identity.
-     * @param int $item_id  Item identity.
-     * @param string $file  File tag.
-     * 
-     * @return boolean      A value indicating success or failure.
-     */
-    public static function saveFile($uid, $item_id, $file)
-    {
-        if (!intval($uid))
-        {
-            return false;
-        }
-
-        $item = Item::selectFirst(['file'], ['id' => $item_id, 'uid' => $uid]);
-        if (DBA::isResult($item))
-        {
-            if (!stristr($item['file'], '[' . self::encode($file) . ']'))
-            {
-                $fields = ['file' => $item['file'] . '[' . self::encode($file) . ']'];
-                Item::update($fields, ['id' => $item_id]);
-            }
-
-            $saved = PConfig::get($uid, 'system', 'filetags');
-
-            if (!strlen($saved) || !stristr($saved, '[' . self::encode($file) . ']'))
-            {
-                PConfig::set($uid, 'system', 'filetags', $saved . '[' . self::encode($file) . ']');
-            }
-
-            info(L10n::t('Item filed'));
-        }
-
-        return true;
-    }
-
-    /**
-     * @brief Remove tag from file
-     * 
-     * @param int $uid      Unique identity.
-     * @param int $item_id  Item identity.
-     * @param string $file  File tag.
-     * @param boolean $cat  Optional value indicating the term type (i.e. Category or File)
-     * 
-     * @return boolean      A value indicating success or failure.
-     */
-    public static function unsaveFile($uid, $item_id, $file, $cat = false)
-    {
-        if (!intval($uid))
-        {
-            return false;
-        }
-
-        if ($cat == true) {
-            $pattern = '<' . self::encode($file) . '>';
-            $termtype = TERM_CATEGORY;
-        } else {
-            $pattern = '[' . self::encode($file) . ']';
-            $termtype = TERM_FILE;
-        }
-
-        $item = Item::selectFirst(['file'], ['id' => $item_id, 'uid' => $uid]);
-
-        if (!DBA::isResult($item))
-        {
-            return false;
-        }
-
-        $fields = ['file' => str_replace($pattern, '', $item['file'])];
-
-        Item::update($fields, ['id' => $item_id]);
-
-        $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
-            DBA::escape($file),
-            intval(TERM_OBJ_POST),
-            intval($termtype),
-            intval($uid)
-        );
-
-        if (!DBA::isResult($r))
-        {
-            $saved = PConfig::get($uid, 'system', 'filetags');
-            PConfig::set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
-        }
-
-        return true;
-    }
+	/**
+	 * URL encode <, >, left and right brackets
+	 *
+	 * @param string $s String to be URL encoded.
+	 *
+	 * @return string   The URL encoded string.
+	 */
+	public static function encode($s)
+	{
+		return str_replace(['<', '>', '[', ']'], ['%3c', '%3e', '%5b', '%5d'], $s);
+	}
+
+	/**
+	 * URL decode <, >, left and right brackets
+	 *
+	 * @param string $s The URL encoded string to be decoded
+	 *
+	 * @return string   The decoded string.
+	 */
+	public static function decode($s)
+	{
+		return str_replace(['%3c', '%3e', '%5b', '%5d'], ['<', '>', '[', ']'], $s);
+	}
+
+	/**
+	 * Query files for tag
+	 *
+	 * @param string $table The table to be queired.
+	 * @param string $s     The search term
+	 * @param string $type  Optional file type.
+	 *
+	 * @return string       Query string.
+	 */
+	public static function fileQuery($table, $s, $type = 'file')
+	{
+		if ($type == 'file') {
+			$str = preg_quote('[' . str_replace('%', '%%', self::encode($s)) . ']');
+		} else {
+			$str = preg_quote('<' . str_replace('%', '%%', self::encode($s)) . '>');
+		}
+
+		return " AND " . (($table) ? DBA::escape($table) . '.' : '') . "file regexp '" . DBA::escape($str) . "' ";
+	}
+
+	/**
+	 * Get file tags from array
+	 *
+	 * ex. given [music,video] return <music><video> or [music][video]
+	 *
+	 * @param array  $array A list of tags.
+	 * @param string $type  Optional file type.
+	 *
+	 * @return string       A list of file tags.
+	 */
+	public static function arrayToFile(array $array, string $type = 'file')
+	{
+		$tag_list = '';
+		if ($type == 'file') {
+			$lbracket = '[';
+			$rbracket = ']';
+		} else {
+			$lbracket = '<';
+			$rbracket = '>';
+		}
+
+		foreach ($array as $item) {
+			if (strlen($item)) {
+				$tag_list .= $lbracket . self::encode(trim($item)) . $rbracket;
+			}
+		}
+
+		return $tag_list;
+	}
+
+	/**
+	 * Get tag list from file tags
+	 *
+	 * ex. given <music><video>[friends], return [music,video] or [friends]
+	 *
+	 * @param string $file File tags
+	 * @param string $type Optional file type.
+	 *
+	 * @return array        List of tag names.
+	 */
+	public static function fileToArray(string $file, string $type = 'file')
+	{
+		$matches = [];
+		$return = [];
+
+		if ($type == 'file') {
+			$cnt = preg_match_all('/\[(.*?)\]/', $file, $matches, PREG_SET_ORDER);
+		} else {
+			$cnt = preg_match_all('/<(.*?)>/', $file, $matches, PREG_SET_ORDER);
+		}
+
+		if ($cnt) {
+			foreach ($matches as $match) {
+				$return[] = self::decode($match[1]);
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Get file tags from list
+	 *
+	 * ex. given music,video return <music><video> or [music][video]
+	 * @param string $list A comma delimited list of tags.
+	 * @param string $type Optional file type.
+	 *
+	 * @return string       A list of file tags.
+	 * @deprecated since 2019.06 use arrayToFile() instead
+	 */
+	public static function listToFile(string $list, string $type = 'file')
+	{
+		$list_array = explode(',', $list);
+
+		return self::arrayToFile($list_array, $type);
+	}
+
+	/**
+	 * Get list from file tags
+	 *
+	 * ex. given <music><video>[friends], return music,video or friends
+	 * @param string $file File tags
+	 * @param string $type Optional file type.
+	 *
+	 * @return string       Comma delimited list of tag names.
+	 * @deprecated since 2019.06 use fileToArray() instead
+	 */
+	public static function fileToList(string $file, $type = 'file')
+	{
+		return implode(',', self::fileToArray($file, $type));
+	}
+
+	/**
+	 * Update file tags in PConfig
+	 *
+	 * @param int    $uid      Unique Identity.
+	 * @param string $file_old Categories previously associated with an item
+	 * @param string $file_new New list of categories for an item
+	 * @param string $type     Optional file type.
+	 *
+	 * @return boolean          A value indicating success or failure.
+	 * @throws \Exception
+	 */
+	public static function updatePconfig(int $uid, string $file_old, string $file_new, string $type = 'file')
+	{
+		if (!intval($uid)) {
+			return false;
+		} elseif ($file_old == $file_new) {
+			return true;
+		}
+
+		$saved = DI::pConfig()->get($uid, 'system', 'filetags');
+
+		if (strlen($saved)) {
+			if ($type == 'file') {
+				$lbracket = '[';
+				$rbracket = ']';
+				$termtype = Category::FILE;
+			} else {
+				$lbracket = '<';
+				$rbracket = '>';
+				$termtype = Category::CATEGORY;
+			}
+
+			$filetags_updated = $saved;
+
+			// check for new tags to be added as filetags in pconfig
+			$new_tags = [];
+			foreach (self::fileToArray($file_new, $type) as $tag) {
+				if (!stristr($saved, $lbracket . self::encode($tag) . $rbracket)) {
+					$new_tags[] = $tag;
+				}
+			}
+
+			$filetags_updated .= self::arrayToFile($new_tags, $type);
+
+			// check for deleted tags to be removed from filetags in pconfig
+			$deleted_tags = [];
+			foreach (self::fileToArray($file_old, $type) as $tag) {
+				if (!stristr($file_new, $lbracket . self::encode($tag) . $rbracket)) {
+					$deleted_tags[] = $tag;
+				}
+			}
+
+			foreach ($deleted_tags as $key => $tag) {
+				if (DBA::exists('category-view', ['name' => $tag, 'type' => $termtype, 'uid' => $uid])) {
+					unset($deleted_tags[$key]);
+				} else {
+					$filetags_updated = str_replace($lbracket . self::encode($tag) . $rbracket, '', $filetags_updated);
+				}
+			}
+
+			if ($saved != $filetags_updated) {
+				DI::pConfig()->set($uid, 'system', 'filetags', $filetags_updated);
+			}
+
+			return true;
+		} elseif (strlen($file_new)) {
+			DI::pConfig()->set($uid, 'system', 'filetags', $file_new);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Add tag to file
+	 *
+	 * @param int    $uid     Unique identity.
+	 * @param int    $item_id Item identity.
+	 * @param string $file    File tag.
+	 *
+	 * @return boolean      A value indicating success or failure.
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	public static function saveFile($uid, $item_id, $file)
+	{
+		if (!intval($uid)) {
+			return false;
+		}
+
+		$item = Item::selectFirst(['file'], ['id' => $item_id, 'uid' => $uid]);
+		if (DBA::isResult($item)) {
+			if (!stristr($item['file'], '[' . self::encode($file) . ']')) {
+				$fields = ['file' => $item['file'] . '[' . self::encode($file) . ']'];
+				Item::update($fields, ['id' => $item_id]);
+			}
+
+			$saved = DI::pConfig()->get($uid, 'system', 'filetags');
+
+			if (!strlen($saved) || !stristr($saved, '[' . self::encode($file) . ']')) {
+				DI::pConfig()->set($uid, 'system', 'filetags', $saved . '[' . self::encode($file) . ']');
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Remove tag from file
+	 *
+	 * @param int     $uid     Unique identity.
+	 * @param int     $item_id Item identity.
+	 * @param string  $file    File tag.
+	 * @param boolean $cat     Optional value indicating the term type (i.e. Category or File)
+	 *
+	 * @return boolean      A value indicating success or failure.
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	public static function unsaveFile($uid, $item_id, $file, $cat = false)
+	{
+		if (!intval($uid)) {
+			return false;
+		}
+
+		if ($cat == true) {
+			$pattern = '<' . self::encode($file) . '>';
+			$termtype = Category::CATEGORY;
+		} else {
+			$pattern = '[' . self::encode($file) . ']';
+			$termtype = Category::FILE;
+		}
+
+		$item = Item::selectFirst(['file'], ['id' => $item_id, 'uid' => $uid]);
+
+		if (!DBA::isResult($item)) {
+			return false;
+		}
+
+		$fields = ['file' => str_replace($pattern, '', $item['file'])];
+
+		Item::update($fields, ['id' => $item_id]);
+
+		if (!DBA::exists('category-view', ['name' => $file, 'type' => $termtype, 'uid' => $uid])) {
+			$saved = DI::pConfig()->get($uid, 'system', 'filetags');
+			DI::pConfig()->set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
+		}
+
+		return true;
+	}
 }