OKAPI Project update (r556).
This commit is contained in:
Wojciech Rygielski
File diff suppressed because it is too large
Load Diff
@ -19,7 +19,7 @@ class OkapiDataStore extends OAuthDataStore
|
||||
$row['url'], $row['email']);
|
||||
}
|
||||
|
||||
public function lookup_token(OkapiConsumer $consumer, $token_type, $token)
|
||||
public function lookup_token($consumer, $token_type, $token)
|
||||
{
|
||||
$row = Db::select_row("
|
||||
select `key`, consumer_key, secret, token_type, user_id, verifier, callback
|
||||
@ -45,10 +45,10 @@ class OkapiDataStore extends OAuthDataStore
|
||||
}
|
||||
}
|
||||
|
||||
public function lookup_nonce(OkapiConsumer $consumer, $token, $nonce, $timestamp)
|
||||
public function lookup_nonce($consumer, $token, $nonce, $timestamp)
|
||||
{
|
||||
# First, see if it exists. Note, that old nonces are periodically deleted.
|
||||
|
||||
|
||||
$exists = Db::select_value("
|
||||
select 1
|
||||
from okapi_nonces
|
||||
@ -59,9 +59,9 @@ class OkapiDataStore extends OAuthDataStore
|
||||
");
|
||||
if ($exists)
|
||||
return $nonce;
|
||||
|
||||
|
||||
# It didn't exist. We have to remember it.
|
||||
|
||||
|
||||
Db::execute("
|
||||
insert into okapi_nonces (consumer_key, `key`, timestamp)
|
||||
values (
|
||||
@ -73,7 +73,7 @@ class OkapiDataStore extends OAuthDataStore
|
||||
return null;
|
||||
}
|
||||
|
||||
public function new_request_token(OkapiConsumer $consumer, $callback)
|
||||
public function new_request_token($consumer, $callback = null)
|
||||
{
|
||||
if ((preg_match("#^[a-z][a-z0-9_.-]*://#", $callback) > 0) ||
|
||||
$callback == "oob")
|
||||
@ -102,7 +102,7 @@ class OkapiDataStore extends OAuthDataStore
|
||||
return $token;
|
||||
}
|
||||
|
||||
public function new_access_token(OkapiRequestToken $token, $consumer, $verifier)
|
||||
public function new_access_token($token, $consumer, $verifier = null)
|
||||
{
|
||||
if ($token->consumer_key != $consumer->key)
|
||||
throw new BadRequest("Request Token given is not associated with the Consumer who signed the request.");
|
||||
@ -110,19 +110,19 @@ class OkapiDataStore extends OAuthDataStore
|
||||
throw new BadRequest("Request Token given has not been authorized.");
|
||||
if ($token->verifier != $verifier)
|
||||
throw new BadRequest("Invalid verifier.");
|
||||
|
||||
|
||||
# Invalidate the Request Token.
|
||||
|
||||
|
||||
Db::execute("
|
||||
delete from okapi_tokens
|
||||
where `key` = '".mysql_real_escape_string($token->key)."'
|
||||
");
|
||||
|
||||
|
||||
# In OKAPI, all Access Tokens are long lived. Therefore, we don't want
|
||||
# to generate a new one every time a Consumer wants it. We will check
|
||||
# if there is already an Access Token generated for this (Consumer, User)
|
||||
# pair and return it if there is.
|
||||
|
||||
|
||||
$row = Db::select_row("
|
||||
select `key`, secret
|
||||
from okapi_tokens
|
||||
@ -134,14 +134,14 @@ class OkapiDataStore extends OAuthDataStore
|
||||
if ($row)
|
||||
{
|
||||
# Use existing Access Token
|
||||
|
||||
|
||||
$access_token = new OkapiAccessToken($row['key'], $row['secret'],
|
||||
$consumer->key, $token->authorized_by_user_id);
|
||||
}
|
||||
else
|
||||
{
|
||||
# Generate a new Access Token.
|
||||
|
||||
|
||||
$access_token = new OkapiAccessToken(Okapi::generate_key(20), Okapi::generate_key(40),
|
||||
$consumer->key, $token->authorized_by_user_id);
|
||||
Db::execute("
|
||||
@ -159,7 +159,7 @@ class OkapiDataStore extends OAuthDataStore
|
||||
}
|
||||
return $access_token;
|
||||
}
|
||||
|
||||
|
||||
public function cleanup()
|
||||
{
|
||||
Db::execute("
|
||||
|
||||
@ -227,6 +227,22 @@
|
||||
<li><b>description</b> - plain-text longer description of the waypoint.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><b>country</b> - name of the country the cache is placed in.</p>
|
||||
<p><b>Note:</b> This data is user-supplied and is not validated in
|
||||
any way. Consider using external geocoding services instead. Also,
|
||||
currently you have no way of knowing in which language it will appear
|
||||
in (but it *may* start to vary on the value of your <b>langpref</b>
|
||||
parameter in the future).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><b>state</b> - name of the state the cache is placed in.</p>
|
||||
<p><b>Note:</b> This data is user-supplied and is not validated in
|
||||
any way. Consider using external geocoding services instead. Also,
|
||||
currently you have no way of knowing in which language it will appear
|
||||
in (but it *may* start to vary on the value of your <b>langpref</b>
|
||||
parameter in the future).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><b>last_found</b> - date and time (ISO 8601) when the
|
||||
geocache was last found <b>or null</b> when it hasn't been yet found.</p>
|
||||
|
||||
@ -23,7 +23,7 @@ class WebService
|
||||
'min_auth_level' => 1
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
private static $valid_field_names = array('code', 'name', 'names', 'location', 'type',
|
||||
'status', 'url', 'owner', 'distance', 'bearing', 'bearing2', 'bearing3', 'is_found',
|
||||
'is_not_found', 'founds', 'notfounds', 'size', 'size2', 'oxsize', 'difficulty', 'terrain',
|
||||
@ -31,8 +31,8 @@ class WebService
|
||||
'descriptions', 'hint', 'hints', 'images', 'attrnames', 'latest_logs',
|
||||
'my_notes', 'trackables_count', 'trackables', 'alt_wpts', 'last_found',
|
||||
'last_modified', 'date_created', 'date_hidden', 'internal_id', 'is_watched',
|
||||
'is_ignored', 'willattends');
|
||||
|
||||
'is_ignored', 'willattends', 'country', 'state');
|
||||
|
||||
public static function call(OkapiRequest $request)
|
||||
{
|
||||
$cache_codes = $request->get_parameter('cache_codes');
|
||||
@ -45,24 +45,24 @@ class WebService
|
||||
}
|
||||
else
|
||||
$cache_codes = explode("|", $cache_codes);
|
||||
|
||||
|
||||
if ((count($cache_codes) > 500) && (!$request->skip_limits))
|
||||
throw new InvalidParam('cache_codes', "Maximum allowed number of referenced ".
|
||||
"caches is 500. You provided ".count($cache_codes)." cache codes.");
|
||||
if (count($cache_codes) != count(array_unique($cache_codes)))
|
||||
throw new InvalidParam('cache_codes', "Duplicate codes detected (make sure each cache is referenced only once).");
|
||||
|
||||
|
||||
$langpref = $request->get_parameter('langpref');
|
||||
if (!$langpref) $langpref = "en";
|
||||
$langpref = explode("|", $langpref);
|
||||
|
||||
|
||||
$fields = $request->get_parameter('fields');
|
||||
if (!$fields) $fields = "code|name|location|type|status";
|
||||
$fields = explode("|", $fields);
|
||||
foreach ($fields as $field)
|
||||
if (!in_array($field, self::$valid_field_names))
|
||||
throw new InvalidParam('fields', "'$field' is not a valid field code.");
|
||||
|
||||
|
||||
$user_uuid = $request->get_parameter('user_uuid');
|
||||
if ($user_uuid != null)
|
||||
{
|
||||
@ -76,7 +76,7 @@ class WebService
|
||||
$user_id = $request->token->user_id;
|
||||
else
|
||||
$user_id = null;
|
||||
|
||||
|
||||
$lpc = $request->get_parameter('lpc');
|
||||
if ($lpc === null) $lpc = 10;
|
||||
if ($lpc == 'all')
|
||||
@ -89,7 +89,7 @@ class WebService
|
||||
if ($lpc < 0)
|
||||
throw new InvalidParam('lpc', "Must be a positive value.");
|
||||
}
|
||||
|
||||
|
||||
if (in_array('distance', $fields) || in_array('bearing', $fields) || in_array('bearing2', $fields)
|
||||
|| in_array('bearing3', $fields))
|
||||
{
|
||||
@ -117,13 +117,13 @@ class WebService
|
||||
# DE branch:
|
||||
# - Caches do not have ratings.
|
||||
# - Total numbers of founds and notfounds are kept in the "stat_caches" table.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select
|
||||
c.cache_id, c.name, c.longitude, c.latitude, c.last_modified,
|
||||
c.date_created, c.type, c.status, c.date_hidden, c.size, c.difficulty,
|
||||
c.terrain, c.wp_oc, c.logpw, c.user_id,
|
||||
|
||||
|
||||
ifnull(sc.toprating, 0) as topratings,
|
||||
ifnull(sc.found, 0) as founds,
|
||||
ifnull(sc.notfound, 0) as notfounds,
|
||||
@ -143,13 +143,13 @@ class WebService
|
||||
# PL branch:
|
||||
# - Caches have ratings.
|
||||
# - Total numbers of found and notfounds are kept in the "caches" table.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select
|
||||
c.cache_id, c.name, c.longitude, c.latitude, c.last_modified,
|
||||
c.date_created, c.type, c.status, c.date_hidden, c.size, c.difficulty,
|
||||
c.terrain, c.wp_oc, c.logpw, c.user_id,
|
||||
|
||||
|
||||
c.topratings,
|
||||
c.founds,
|
||||
c.notfounds,
|
||||
@ -264,6 +264,8 @@ class WebService
|
||||
case 'trackables_count': /* handled separately */ break;
|
||||
case 'trackables': /* handled separately */ break;
|
||||
case 'alt_wpts': /* handled separately */ break;
|
||||
case 'country': /* handled separately */ break;
|
||||
case 'state': /* handled separately */ break;
|
||||
case 'last_found': $entry['last_found'] = ($row['last_found'] > '1980') ? date('c', strtotime($row['last_found'])) : null; break;
|
||||
case 'last_modified': $entry['last_modified'] = date('c', strtotime($row['last_modified'])); break;
|
||||
case 'date_created': $entry['date_created'] = date('c', strtotime($row['date_created'])); break;
|
||||
@ -275,9 +277,9 @@ class WebService
|
||||
$results[$row['wp_oc']] = $entry;
|
||||
}
|
||||
mysql_free_result($rs);
|
||||
|
||||
|
||||
# owner
|
||||
|
||||
|
||||
if (in_array('owner', $fields) && (count($results) > 0))
|
||||
{
|
||||
$rs = Db::query("
|
||||
@ -298,9 +300,9 @@ class WebService
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# is_found
|
||||
|
||||
|
||||
if (in_array('is_found', $fields))
|
||||
{
|
||||
if ($user_id == null)
|
||||
@ -325,9 +327,9 @@ class WebService
|
||||
foreach ($results as $cache_code => &$result_ref)
|
||||
$result_ref['is_found'] = isset($tmp2[$cache_code]);
|
||||
}
|
||||
|
||||
|
||||
# is_not_found
|
||||
|
||||
|
||||
if (in_array('is_not_found', $fields))
|
||||
{
|
||||
if ($user_id == null)
|
||||
@ -349,9 +351,9 @@ class WebService
|
||||
foreach ($results as $cache_code => &$result_ref)
|
||||
$result_ref['is_not_found'] = isset($tmp2[$cache_code]);
|
||||
}
|
||||
|
||||
|
||||
# is_watched
|
||||
|
||||
|
||||
if (in_array('is_watched', $fields))
|
||||
{
|
||||
if ($request->token == null)
|
||||
@ -373,7 +375,7 @@ class WebService
|
||||
}
|
||||
|
||||
# is_ignored
|
||||
|
||||
|
||||
if (in_array('is_ignored', $fields))
|
||||
{
|
||||
if ($request->token == null)
|
||||
@ -395,20 +397,20 @@ class WebService
|
||||
}
|
||||
|
||||
# Descriptions and hints.
|
||||
|
||||
|
||||
if (in_array('description', $fields) || in_array('descriptions', $fields)
|
||||
|| in_array('hint', $fields) || in_array('hints', $fields))
|
||||
{
|
||||
# At first, we will fill all those 4 fields, even if user requested just one
|
||||
# of them. We will chop off the remaining three at the end.
|
||||
|
||||
|
||||
foreach ($results as &$result_ref)
|
||||
$result_ref['descriptions'] = array();
|
||||
foreach ($results as &$result_ref)
|
||||
$result_ref['hints'] = array();
|
||||
|
||||
|
||||
# Get cache descriptions and hints.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select cache_id, language, `desc`, hint
|
||||
from cache_desc
|
||||
@ -429,17 +431,17 @@ class WebService
|
||||
$result_ref['description'] = Okapi::pick_best_language($result_ref['descriptions'], $langpref);
|
||||
$result_ref['hint'] = Okapi::pick_best_language($result_ref['hints'], $langpref);
|
||||
}
|
||||
|
||||
|
||||
# Remove unwanted fields.
|
||||
|
||||
|
||||
foreach (array('description', 'descriptions', 'hint', 'hints') as $field)
|
||||
if (!in_array($field, $fields))
|
||||
foreach ($results as &$result_ref)
|
||||
unset($result_ref[$field]);
|
||||
}
|
||||
|
||||
|
||||
# Images.
|
||||
|
||||
|
||||
if (in_array('images', $fields))
|
||||
{
|
||||
foreach ($results as &$result_ref)
|
||||
@ -474,18 +476,18 @@ class WebService
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# Attrnames
|
||||
|
||||
|
||||
if (in_array('attrnames', $fields))
|
||||
{
|
||||
foreach ($results as &$result_ref)
|
||||
$result_ref['attrnames'] = array();
|
||||
|
||||
|
||||
# ALL attribute names are loaded into memory here. Assuming there are
|
||||
# not so many of them, this will be fast enough. Possible optimalization:
|
||||
# Let mysql do the matching.
|
||||
|
||||
|
||||
$dict = Okapi::get_all_atribute_names();
|
||||
$rs = Db::query("
|
||||
select cache_id, attrib_id
|
||||
@ -503,17 +505,17 @@ class WebService
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# Latest log entries.
|
||||
|
||||
|
||||
if (in_array('latest_logs', $fields))
|
||||
{
|
||||
foreach ($results as &$result_ref)
|
||||
$result_ref['latest_logs'] = array();
|
||||
|
||||
|
||||
# Get all log IDs with dates. Sort in groups. Filter out latest ones. This is the fastest
|
||||
# technique I could think of...
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select cache_id, id, date
|
||||
from cache_logs
|
||||
@ -546,9 +548,9 @@ class WebService
|
||||
while ($row = mysql_fetch_assoc($rs))
|
||||
$logids[] = $row['id'];
|
||||
}
|
||||
|
||||
|
||||
# Now retrieve text and join.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select cl.cache_id, cl.id, cl.uuid, cl.type, unix_timestamp(cl.date) as date, cl.text,
|
||||
u.uuid as user_uuid, u.username, u.user_id
|
||||
@ -575,9 +577,9 @@ class WebService
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# My notes
|
||||
|
||||
|
||||
if (in_array('my_notes', $fields))
|
||||
{
|
||||
if ($request->token == null)
|
||||
@ -587,7 +589,7 @@ class WebService
|
||||
if (Settings::get('OC_BRANCH') == 'oc.pl')
|
||||
{
|
||||
# OCPL uses cache_notes table to store notes.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select cache_id, max(date) as date, group_concat(`desc`) as `desc`
|
||||
from cache_notes
|
||||
@ -600,7 +602,7 @@ class WebService
|
||||
else
|
||||
{
|
||||
# OCDE uses coordinates table (with type == 2) to store notes (this is somewhat weird).
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select cache_id, null as date, group_concat(description) as `desc`
|
||||
from coordinates
|
||||
@ -617,12 +619,12 @@ class WebService
|
||||
$results[$cacheid2wptcode[$row['cache_id']]]['my_notes'] = strip_tags($row['desc']);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (in_array('trackables', $fields))
|
||||
{
|
||||
# Currently we support Geokrety only. But this interface should remain
|
||||
# compatible. In future, other trackables might be returned the same way.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select
|
||||
gkiw.wp as cache_code,
|
||||
@ -683,9 +685,9 @@ class WebService
|
||||
unset($tr_counts);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# Alternate/Additional waypoints.
|
||||
|
||||
|
||||
if (in_array('alt_wpts', $fields))
|
||||
{
|
||||
foreach ($results as &$result_ref)
|
||||
@ -696,7 +698,7 @@ class WebService
|
||||
# a special 'status' field to denote a hidden waypoint (i.e. final location
|
||||
# of a multicache). Such hidden waypoints are not exposed by OKAPI. A stage
|
||||
# fields is used for ordering and naming.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select
|
||||
cache_id, stage, latitude, longitude, `desc`,
|
||||
@ -717,7 +719,7 @@ class WebService
|
||||
{
|
||||
# OCDE uses 'coordinates' table (with type=1) to store additional waypoints.
|
||||
# All waypoints are are public.
|
||||
|
||||
|
||||
$rs = Db::query("
|
||||
select
|
||||
cache_id,
|
||||
@ -745,25 +747,62 @@ class WebService
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# Country and/or state.
|
||||
|
||||
if (in_array('country', $fields) || in_array('state', $fields))
|
||||
{
|
||||
$rs = Db::query("
|
||||
select
|
||||
c.wp_oc as cache_code,
|
||||
cl.adm1 as country,
|
||||
cl.adm3 as state
|
||||
from
|
||||
caches c,
|
||||
cache_location cl
|
||||
where
|
||||
c.wp_oc in ('".implode("','", array_map('mysql_real_escape_string', $cache_codes))."')
|
||||
and c.cache_id = cl.cache_id
|
||||
");
|
||||
$countries = array();
|
||||
$states = array();
|
||||
while ($row = mysql_fetch_assoc($rs))
|
||||
{
|
||||
$countries[$row['cache_code']] = $row['country'];
|
||||
$states[$row['cache_code']] = $row['state'];
|
||||
}
|
||||
if (in_array('country', $fields))
|
||||
{
|
||||
foreach ($results as $cache_code => &$row_ref)
|
||||
$row_ref['country'] = isset($countries[$cache_code]) ? $countries[$cache_code] : null;
|
||||
}
|
||||
if (in_array('state', $fields))
|
||||
{
|
||||
foreach ($results as $cache_code => &$row_ref)
|
||||
$row_ref['state'] = isset($states[$cache_code]) ? $states[$cache_code] : null;
|
||||
}
|
||||
unset($countries);
|
||||
unset($states);
|
||||
}
|
||||
|
||||
# Check which cache codes were not found and mark them with null.
|
||||
foreach ($cache_codes as $cache_code)
|
||||
if (!isset($results[$cache_code]))
|
||||
$results[$cache_code] = null;
|
||||
|
||||
|
||||
# Order the results in the same order as the input codes were given.
|
||||
# This might come in handy for languages which support ordered dictionaries
|
||||
# (especially with conjunction with the search_and_retrieve method).
|
||||
# See issue#97. PHP dictionaries (assoc arrays) are ordered structures,
|
||||
# so we just have to rewrite it (sequentially).
|
||||
|
||||
|
||||
$ordered_results = array();
|
||||
foreach ($cache_codes as $cache_code)
|
||||
$ordered_results[$cache_code] = $results[$cache_code];
|
||||
|
||||
|
||||
return Okapi::formatted_response($request, $ordered_results);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Create unique caption, safe to be used as a file name for images
|
||||
* uploaded into Garmin's GPS devices. Use reset_unique_captions to reset
|
||||
@ -774,11 +813,11 @@ class WebService
|
||||
# Garmins keep hanging on long file names. We don't have any specification from
|
||||
# Garmin and cannot determine WHY. That's why we won't use captions until we
|
||||
# know more.
|
||||
|
||||
|
||||
$caption = self::$caption_no."";
|
||||
self::$caption_no++;
|
||||
return $caption;
|
||||
|
||||
|
||||
/* This code is harmful for Garmins!
|
||||
$caption = preg_replace('#[^\\pL\d ]+#u', '-', $caption);
|
||||
$caption = trim($caption, '-');
|
||||
@ -805,15 +844,15 @@ class WebService
|
||||
{
|
||||
self::$caption_no = 1;
|
||||
}
|
||||
|
||||
|
||||
public static function get_cache_attribution_note($cache_id, $lang)
|
||||
{
|
||||
$site_url = Settings::get('SITE_URL');
|
||||
$site_name = Okapi::get_normalized_site_name();
|
||||
$cache_url = $site_url."viewcache.php?cacheid=$cache_id";
|
||||
|
||||
|
||||
# This list if to be extended (opencaching.de, etc.). (_)
|
||||
|
||||
|
||||
switch ($lang)
|
||||
{
|
||||
case 'pl':
|
||||
|
||||
@ -106,9 +106,10 @@
|
||||
been found at most <i>N</i> times. Useful for FTF hunters.</p>
|
||||
</opt>
|
||||
<opt name='modified_since'>
|
||||
<p>A date and time string. This should be in ISO 8601 format (although currently
|
||||
any format acceptable by PHP's <a href='http://pl2.php.net/strtotime'>strtotime</a>
|
||||
function also will do).</p>
|
||||
<p>A date and time string. This should be in ISO 8601 format (currently any
|
||||
format acceptable by PHP's <a href='http://pl2.php.net/strtotime'>strtotime</a>
|
||||
function also will do, but most of them don't handle time zones properly,
|
||||
try to use ISO 8601!).</p>
|
||||
<p>If given, the list of returned geocaches will be limited to those which were
|
||||
created or modified since that date. (Note: currently caches do not get
|
||||
"modified" when user makes a log entry.)</p>
|
||||
|
||||
@ -20,9 +20,10 @@
|
||||
However, you should not (this may stop working at any time).</p>
|
||||
</opt>
|
||||
<opt name='when'>
|
||||
<p>A date and time string. This should be in ISO 8601 format (although currently
|
||||
any format acceptable by PHP's <a href='http://pl2.php.net/strtotime'>strtotime</a>
|
||||
function also will do).</p>
|
||||
<p>A date and time string. This should be in ISO 8601 format (currently any
|
||||
format acceptable by PHP's <a href='http://pl2.php.net/strtotime'>strtotime</a>
|
||||
function also will do, but most of them don't handle time zones properly,
|
||||
try to use ISO 8601!).</p>
|
||||
<p>Indicates when the cache was found. If given, the log will be published
|
||||
with the given date and time. If not, log will be published using the current
|
||||
date and time.</p>
|
||||
|
||||
@ -21,37 +21,49 @@ final class Settings
|
||||
{
|
||||
/** Default values for setting keys. */
|
||||
private static $DEFAULT_SETTINGS = array(
|
||||
|
||||
|
||||
/**
|
||||
* List of administrator email addresses. OKAPI will send important messages
|
||||
* to this addresses. You should replace this with your true email address.
|
||||
*/
|
||||
'ADMINS' => array(),
|
||||
|
||||
|
||||
/** Set this to true on development machines. */
|
||||
'DEBUG' => false,
|
||||
|
||||
/**
|
||||
* Currently there are two mainstream branches of OpenCaching code.
|
||||
* Which branch is you installation using?
|
||||
*
|
||||
*
|
||||
* Possible values: "oc.pl" or "oc.de". (As far as we know, oc.us and
|
||||
* oc.org.uk use "oc.pl" branch, the rest uses "oc.de" branch.)
|
||||
*/
|
||||
'OC_BRANCH' => "oc.pl",
|
||||
|
||||
|
||||
/**
|
||||
* Each OpenCaching site has a default language. I.e. the language in
|
||||
* which all the names of caches are entered. What is the ISO 639-1 code
|
||||
* of this language? Note: ISO 639-1 codes are always lowercase.
|
||||
*
|
||||
*
|
||||
* E.g. "pl", "en", "de".
|
||||
*/
|
||||
'SITELANG' => "en",
|
||||
|
||||
|
||||
/**
|
||||
* If set, it will be passed to date_default_timezone_set. OKAPI may
|
||||
* refuse to start if this value is unset (more information here:
|
||||
* http://code.google.com/p/opencaching-api/issues/detail?id=177)
|
||||
* You should set it to the timezone used in your country (the one you'd
|
||||
* use for your database inserts etc.). Choose one of the values listed
|
||||
* here: http://www.php.net/manual/en/timezones.php
|
||||
*
|
||||
* E.g. "Europe/Berlin", "America/New_York".
|
||||
*/
|
||||
'TIMEZONE' => null,
|
||||
|
||||
/** Email address to use in the "From:" when sending messages. */
|
||||
'FROM_FIELD' => 'root@localhost',
|
||||
|
||||
|
||||
/**
|
||||
* All OKAPI documentation pages should remain English-only, but some
|
||||
* other pages (and results) might be translated to their localized
|
||||
@ -63,80 +75,80 @@ final class Settings
|
||||
* function below for details.
|
||||
*/
|
||||
'GETTEXT_INIT' => array('\okapi\Settings', 'default_gettext_init'),
|
||||
|
||||
|
||||
/**
|
||||
* By default, OKAPI uses "okapi_messages" domain file for translations.
|
||||
* Use this variable when you want it to use your own domain.
|
||||
*/
|
||||
'GETTEXT_DOMAIN' => 'okapi_messages',
|
||||
|
||||
|
||||
/**
|
||||
* Where should OKAPI store dynamically generated cache files? If you leave it at null,
|
||||
* OKAPI will try to guess (not recommended). If you move this directory, it's better
|
||||
* if you also move all the files which were inside.
|
||||
*/
|
||||
'VAR_DIR' => null,
|
||||
|
||||
|
||||
/**
|
||||
* Where to store uploaded images? This directory needs to be shared among
|
||||
* both OKAPI and OC code (see $picdir in your settings.inc.php).
|
||||
*/
|
||||
'IMAGES_DIR' => null,
|
||||
|
||||
|
||||
/**
|
||||
* Name of the cookie within which OC stores serialized session id, etc.
|
||||
* OKAPI requires to access this in order to make sure which user is logged
|
||||
* in.
|
||||
*/
|
||||
'OC_COOKIE_NAME' => null,
|
||||
|
||||
|
||||
/**
|
||||
* Set to true, if your installation supports "Needs maintenance" log type (with
|
||||
* log type id == 5). If your users are not allowed to submit "Needs maintenance"
|
||||
* log entries, leave it at false.
|
||||
*/
|
||||
'SUPPORTS_LOGTYPE_NEEDS_MAINTENANCE' => false,
|
||||
|
||||
|
||||
/**
|
||||
* Set to true, to prevent OKAPI from sending email messages. ALLOWED ONLY ON
|
||||
* DEVELOPMENT ENVIRONMENT! Sending emails is vital for OKAPI administration and
|
||||
* usage! (I.e. users need this to receive their tokens upon registration.)
|
||||
*/
|
||||
'DEBUG_PREVENT_EMAILS' => false,
|
||||
|
||||
|
||||
/**
|
||||
* Set to true, to prevent OKAPI from using sem_get family of functions.
|
||||
* ALLOWED ONLY ON DEVELOPMENT ENVIRONMENT! Semaphores are vital for OKAPI's
|
||||
* performance and data integrity!
|
||||
*/
|
||||
'DEBUG_PREVENT_SEMAPHORES' => false,
|
||||
|
||||
|
||||
/* Database settings */
|
||||
|
||||
|
||||
'DB_SERVER' => 'localhost',
|
||||
'DB_NAME' => null,
|
||||
'DB_USERNAME' => null,
|
||||
'DB_PASSWORD' => null,
|
||||
|
||||
|
||||
/** URL of the OC site (with slash, and without the "/okapi" part). */
|
||||
'SITE_URL' => null,
|
||||
|
||||
|
||||
/** OKAPI needs this when inserting new data to cache_logs table. */
|
||||
'OC_NODE_ID' => null,
|
||||
|
||||
|
||||
/**
|
||||
* Your OC sites data licencing document. All OKAPI Consumers will be
|
||||
* required to accept this.
|
||||
*/
|
||||
'DATA_LICENSE_URL' => null,
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
/**
|
||||
* Final values for settings keys (defaults + local overrides).
|
||||
* (Loaded upon first access.)
|
||||
*/
|
||||
private static $SETTINGS = null;
|
||||
|
||||
|
||||
/**
|
||||
* Initialize self::$SETTINGS.
|
||||
*/
|
||||
@ -145,12 +157,12 @@ final class Settings
|
||||
try {
|
||||
# This is an external code and it MAY generate E_NOTICEs.
|
||||
# We have to temporarilly disable our default error handler.
|
||||
|
||||
|
||||
OkapiErrorHandler::disable();
|
||||
require_once($GLOBALS['rootpath']."okapi_settings.php");
|
||||
$ref = get_okapi_settings();
|
||||
OkapiErrorHandler::reenable();
|
||||
|
||||
|
||||
} catch (Exception $e) {
|
||||
throw new Exception("Could not import <rootpath>/okapi_settings.php:\n".$e->getMessage());
|
||||
}
|
||||
@ -164,7 +176,7 @@ final class Settings
|
||||
}
|
||||
self::verify(self::$SETTINGS);
|
||||
}
|
||||
|
||||
|
||||
private static function verify($dict)
|
||||
{
|
||||
if (!in_array($dict['OC_BRANCH'], array('oc.pl', 'oc.de')))
|
||||
@ -193,26 +205,26 @@ final class Settings
|
||||
if ($dict['SITE_URL'][strlen($dict['SITE_URL']) - 1] != '/')
|
||||
throw new Exception("SITE_URL must end with a slash.");
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
/**
|
||||
* Get the value for the $key setting.
|
||||
*/
|
||||
public static function get($key)
|
||||
{
|
||||
if (self::$SETTINGS == null)
|
||||
self::load_settings();
|
||||
|
||||
|
||||
if (!array_key_exists($key, self::$SETTINGS))
|
||||
throw new Exception("Tried to access an invalid settings key: '$key'");
|
||||
|
||||
|
||||
return self::$SETTINGS[$key];
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Bind "okapi_messages" with our local i18n database. Set proper locale
|
||||
* based on the language codes passed and return the locale code.
|
||||
* $langprefs is a list of language codes in order of preference.
|
||||
*
|
||||
*
|
||||
* Please note, that OKAPI consumers may ask OKAPI to return contents
|
||||
* in a specified language. (For example, consumers from Germany may ask
|
||||
* Polish OKAPI server to return GPX file in German.) If you insist on using
|
||||
@ -229,7 +241,7 @@ final class Settings
|
||||
bindtextdomain("okapi_messages", $GLOBALS['rootpath'].'okapi/locale');
|
||||
return $locale;
|
||||
}
|
||||
|
||||
|
||||
public static function describe_settings()
|
||||
{
|
||||
return print_r(self::$SETTINGS, true);
|
||||
|
||||
Reference in New Issue
Block a user