1 files changed, 292 insertions, 0 deletions
diff --git a/src/SemanticScuttle/functions.php b/src/SemanticScuttle/functions.php
new file mode 100644
index 0000000..802a7f1
--- /dev/null
+++ b/src/SemanticScuttle/functions.php
@@ -0,0 +1,292 @@
+<?php
+/**
+ * Defines some commonly used functions.
+ *
+ * SemanticScuttle - your social bookmark manager.
+ *
+ * PHP version 5.
+ *
+ * @category Bookmarking
+ * @package  SemanticScuttle
+ * @author   Benjamin Huynh-Kim-Bang <mensonge@users.sourceforge.net>
+ * @author   Christian Weiske <cweiske@cweiske.de>
+ * @author   Eric Dane <ericdane@users.sourceforge.net>
+ * @license  GPL http://www.gnu.org/licenses/gpl.html
+ * @link     http://sourceforge.net/projects/semanticscuttle
+ */
+
+// Converts tags:
+// - direction = out: convert spaces to underscores;
+// - direction = in: convert underscores to spaces.
+function convertTag($tag, $direction = 'out') {
+	if ($direction == 'out') {
+		$tag = str_replace(' ', '_', $tag);
+	} else {
+		$tag = str_replace('_', ' ', $tag);
+	}
+	return $tag;
+}
+
+function filter($data, $type = NULL) {
+	if (is_string($data)) {
+		$data = trim($data);
+		$data = stripslashes($data);
+		switch ($type) {
+			case 'url':
+				$data = rawurlencode($data);
+				break;
+			default:
+				$data = htmlspecialchars($data);
+				break;
+		}
+	} else if (is_array($data)) {
+		foreach(array_keys($data) as $key) {
+			$row =& $data[$key];
+			$row = filter($row, $type);
+		}
+	}
+	return $data;
+}
+
+/**
+ * Returns the number of bookmarks that shall be displayed on one page.
+ *
+ * @param SemanticScuttle_Model_User $userObject Object of the current user
+ *
+ * @return integer Number of bookmarks per page
+ *
+ * @uses $defaultPerPage
+ * @uses $defaultPerPageForAdmins
+ */
+function getPerPageCount($userObject = null)
+{
+	global $defaultPerPage, $defaultPerPageForAdmins;
+
+	if (isset($defaultPerPageForAdmins)
+        && $userObject != null && $userObject->isAdmin()
+    ) {
+		return $defaultPerPageForAdmins;
+	} else {
+		return $defaultPerPage;
+	}
+}
+
+function getSortOrder($override = NULL) {
+	global $defaultOrderBy;
+
+	if (isset($_GET['sort'])) {
+		return preg_replace('/[^a-z_]/', '', $_GET['sort']);
+	} else if (isset($override)) {
+		return $override;
+	} else {
+		return $defaultOrderBy;
+	}
+}
+
+function multi_array_search($needle, $haystack) {
+	if (is_array($haystack)) {
+		foreach(array_keys($haystack) as $key) {
+			$value =& $haystack[$key];
+			$result = multi_array_search($needle, $value);
+			if (is_array($result)) {
+				$return = $result;
+				array_unshift($return, $key);
+				return $return;
+			} elseif ($result == true) {
+				$return[] = $key;
+				return $return;
+			}
+		}
+		return false;
+	} else {
+		if ($needle === $haystack) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+}
+
+function createURL($page = '', $ending = '') {
+	global $cleanurls;
+	if (!$cleanurls && $page != '') {
+		$page .= '.php';
+	}
+	if(strlen($ending)>0) {
+		return ROOT . $page .'/'. $ending;
+	} else {
+		return ROOT . $page;
+	}
+}
+
+/**
+ * Adds the protocol to the URL if it's missing.
+ * If the current URL is served via HTTPS, https will be used as protocol.
+ *
+ * Useful to fix ROOT urls of SemanticScuttle when it's needed, e.g.
+ * in the bookmarklet or the feed.
+ *
+ * @param string $url Url with or without the protocol ("//example.org/foo")
+ *
+ * @return string URL with a HTTP protocol
+ */
+function addProtocolToUrl($url)
+{
+    if (substr($url, 0, 2) != '//') {
+        return $url;
+    }
+
+    if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) {
+        $protocol = 'https:';
+    } else {
+        $protocol = 'http:';
+    }
+    return $protocol . $url;
+}
+/**
+ * Creates a "vote for/against this bookmark" URL.
+ * Also runs htmlspecialchars() on them to prevent XSS.
+ *
+ * @param boolean $for For the bookmark (true) or against (false)
+ * @param integer $bId Bookmark ID
+ *
+ * @return string URL to use
+ */
+function createVoteURL($for, $bId)
+{
+    return htmlspecialchars(
+        createURL(
+            'vote',
+            ($for ? 'for' : 'against') . '/' . $bId
+        ),
+        ENT_QUOTES
+    );
+}
+
+/* Shorten a string like a URL for example by cutting the middle of it */
+function shortenString($string, $maxSize=75) {
+	$output = '';
+	if(strlen($string) > $maxSize) {
+		$output = substr($string, 0, $maxSize/2).'...'.substr($string, -$maxSize/2);
+	} else {
+		$output = $string;
+	}
+	return $output;
+}
+
+/* Check url format and check online if the url is a valid page (Not a 404 error for example) */
+function checkUrl($url, $checkOnline = true) {
+	//check format
+	if(!preg_match("#(ht|f)tp(s?)\://\S+\.\S+#i",$url)) {
+		return false;
+	}
+
+	if($checkOnline) {
+		//look if the page doesn't return a void or 40X or 50X HTTP code error
+		$h = @get_headers($url);
+		if(is_array($h) && strpos($h[0], '40') === false && strpos($h[0], '50') === false) {
+			return true;
+		} else {
+			return false;
+		}
+	} else {
+		return true;
+	}
+}
+
+/* Returns a concatenated String
+ * including all the tags from the array $arrayTags (excepted of the $exceptedTag)
+ * separated by the $separator.
+ * */
+function aggregateTags($arrayTags, $separator = ' + ', $exceptedTag = '') {
+	$output = '';
+
+	for($i = 0; $i<count($arrayTags); $i++) {
+		if($arrayTags[$i] != $exceptedTag) {
+			$output.= $arrayTags[$i] . $separator;
+		}
+	}
+	return substr($output, 0, strlen($output) - strlen($separator) );
+}
+
+function message_die($msg_code, $msg_text = '', $msg_title = '', $err_line = '', $err_file = '', $sql = '', $db = NULL) {
+	if(defined('HAS_DIED'))
+	die(T_('message_die() was called multiple times.'));
+	define('HAS_DIED', 1);
+
+	$sql_store = $sql;
+
+	// Get SQL error if we are debugging. Do this as soon as possible to prevent
+	// subsequent queries from overwriting the status of sql_error()
+	if (DEBUG_MODE && ($msg_code == GENERAL_ERROR || $msg_code == CRITICAL_ERROR)) {
+		$sql_error = is_null($db) ? '' : $db->sql_error();
+		$debug_text = '';
+
+		if ($sql_error['message'] != '')
+		$debug_text .= '<br /><br />'. T_('SQL Error') .' : '. $sql_error['code'] .' '. $sql_error['message'];
+
+		if ($sql_store != '')
+		$debug_text .= '<br /><br />'. $sql_store;
+
+		if ($err_line != '' && $err_file != '')
+		$debug_text .= '</br /><br />'. T_('Line') .' : '. $err_line .'<br />'. T_('File') .' :'. $err_file;
+
+		debug_print_backtrace();
+	}
+
+	switch($msg_code) {
+		case GENERAL_MESSAGE:
+			if ($msg_title == '')
+			$msg_title = T_('Information');
+			break;
+
+		case CRITICAL_MESSAGE:
+			if ($msg_title == '')
+			$msg_title = T_('Critical Information');
+			break;
+
+		case GENERAL_ERROR:
+			if ($msg_text == '')
+			$msg_text = T_('An error occured');
+
+			if ($msg_title == '')
+			$msg_title = T_('General Error');
+			break;
+
+		case CRITICAL_ERROR:
+			// Critical errors mean we cannot rely on _ANY_ DB information being
+			// available so we're going to dump out a simple echo'd statement
+
+			if ($msg_text == '')
+			$msg_text = T_('An critical error occured');
+
+			if ($msg_title == '')
+			$msg_title = T_('Critical Error');
+			break;
+	}
+
+	// Add on DEBUG_MODE info if we've enabled debug mode and this is an error. This
+	// prevents debug info being output for general messages should DEBUG_MODE be
+	// set TRUE by accident (preventing confusion for the end user!)
+	if (DEBUG_MODE && ($msg_code == GENERAL_ERROR || $msg_code == CRITICAL_ERROR)) {
+		if ($debug_text != '')
+		$msg_text = $msg_text . '<br /><br /><strong>'. T_('DEBUG MODE') .'</strong>'. $debug_text;
+	}
+
+	echo "<html>\n<body>\n". $msg_title ."\n<br /><br />\n". $msg_text ."</body>\n</html>";
+	exit;
+}
+
+/**
+ * Calls reset() on the given arg, without the E_STRICT error
+ * "Only variables should be passed by reference"
+ *
+ * @param array $arg Array to return first element of
+ *
+ * @return mixed First element of the array
+ */
+function rreset($array)
+{
+    return reset($array);
+}
+?>