summaryrefslogtreecommitdiff
path: root/lib/util.php
diff options
context:
space:
mode:
authorBrion Vibber <brion@pobox.com>2009-12-15 18:55:18 -0500
committerBrion Vibber <brion@pobox.com>2009-12-16 09:27:48 -0500
commitdc4bedd25aa75e5f4b5f5a7f7a5d93cd19dcd756 (patch)
tree05212e31b280d497a9d1c4da9f49e7166a9c7b77 /lib/util.php
parent0ca80f78fbb07ebaaa1509c65021eb5f26cf5c99 (diff)
Add some doc comments and fixmes in util.php
Diffstat (limited to 'lib/util.php')
-rw-r--r--lib/util.php29
1 files changed, 27 insertions, 2 deletions
diff --git a/lib/util.php b/lib/util.php
index d4afafb4c..af4885f40 100644
--- a/lib/util.php
+++ b/lib/util.php
@@ -1244,8 +1244,12 @@ function common_copy_args($from)
return $to;
}
-// Neutralise the evil effects of magic_quotes_gpc in the current request.
-// This is used before handing a request off to OAuthRequest::from_request.
+/**
+ * Neutralise the evil effects of magic_quotes_gpc in the current request.
+ * This is used before handing a request off to OAuthRequest::from_request.
+ * @fixme Doesn't consider vars other than _POST and _GET?
+ * @fixme Can't be undone and could corrupt data if run twice.
+ */
function common_remove_magic_from_request()
{
if(get_magic_quotes_gpc()) {
@@ -1447,6 +1451,17 @@ function common_database_tablename($tablename)
return $tablename;
}
+/**
+ * Shorten a URL with the current user's configured shortening service,
+ * or ur1.ca if configured, or not at all if no shortening is set up.
+ * Length is not considered.
+ *
+ * @param string $long_url
+ * @return string may return the original URL if shortening failed
+ *
+ * @fixme provide a way to specify a particular shortener
+ * @fixme provide a way to specify to use a given user's shortening preferences
+ */
function common_shorten_url($long_url)
{
$user = common_current_user();
@@ -1467,6 +1482,16 @@ function common_shorten_url($long_url)
}
}
+/**
+ * @return mixed array($proxy, $ip) for web requests; proxy may be null
+ * null if not a web request
+ *
+ * @fixme X-Forwarded-For can be chained by multiple proxies;
+ we should parse the list and provide a cleaner array
+ * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
+ * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
+ * use function to get exact request headers from Apache if possible.
+ */
function common_client_ip()
{
if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {