From 8c94ebf5375fe8ab9cb450525436396404d3fd33 Mon Sep 17 00:00:00 2001 From: Siebrand Mazeland Date: Mon, 13 Sep 2010 00:49:42 +0200 Subject: [PATCH] * update/add translator documentation * remove superfluous whitespace --- lib/action.php | 10 +++++++++- lib/activity.php | 1 - lib/activitycontext.php | 1 - lib/activityobject.php | 2 -- lib/activityutils.php | 9 +++------ lib/activityverb.php | 1 - lib/adminform.php | 3 --- lib/adminpanelaction.php | 14 ------------- lib/apiaction.php | 12 ----------- lib/apiauth.php | 33 ++++++++++--------------------- lib/attachmentnoticesection.php | 1 + lib/attachmenttagcloudsection.php | 1 + 12 files changed, 24 insertions(+), 64 deletions(-) diff --git a/lib/action.php b/lib/action.php index e503975147..5c4b4a7b7d 100644 --- a/lib/action.php +++ b/lib/action.php @@ -840,6 +840,9 @@ class Action extends HTMLOutputter // lawsuit $this->elementStart('dd', null); if (common_config('site', 'broughtby')) { // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set. + // TRANS: Text between [] is a link description, text between () is the link itself. + // TRANS: Make sure there is no whitespace between "]" and "(". + // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).'); } else { // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set. @@ -847,6 +850,9 @@ class Action extends HTMLOutputter // lawsuit } $instr .= ' '; // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license. + // TRANS: Make sure there is no whitespace between "]" and "(". + // TRANS: Text between [] is a link description, text between () is the link itself. + // TRANS: %s is the version of StatusNet that is being used. $instr .= sprintf(_('It runs the [StatusNet](http://status.net/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), STATUSNET_VERSION); $output = common_markup_to_html($instr); $this->raw($output); @@ -893,7 +899,8 @@ class Action extends HTMLOutputter // lawsuit 'width' => '80', 'height' => '15')); $this->text(' '); - // TRANS: license message in footer. %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration. + // TRANS: license message in footer. + // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration. $notice = _('All %1$s content and data are available under the %2$s license.'); $link = "trimmed('token'); if (empty($token) || $token != common_session_token()) { + // TRANS: Client error text when there is a problem with the session token. $this->clientError(_('There was a problem with your session token.')); } } diff --git a/lib/activity.php b/lib/activity.php index 8e2da99bb3..09a4daee82 100644 --- a/lib/activity.php +++ b/lib/activity.php @@ -387,4 +387,3 @@ class Activity return ActivityUtils::child($element, $tag, $namespace); } } - diff --git a/lib/activitycontext.php b/lib/activitycontext.php index 09a4579249..cc02a01955 100644 --- a/lib/activitycontext.php +++ b/lib/activitycontext.php @@ -73,7 +73,6 @@ class ActivityContext $attention = array(); for ($i = 0; $i < $links->length; $i++) { - $link = $links->item($i); $linkRel = $link->getAttribute(ActivityUtils::REL); diff --git a/lib/activityobject.php b/lib/activityobject.php index 677a48197f..0fc06948bb 100644 --- a/lib/activityobject.php +++ b/lib/activityobject.php @@ -168,7 +168,6 @@ class ActivityObject ActivityObject::MEDIA_DESCRIPTION, Activity::MEDIA ); - } } @@ -418,7 +417,6 @@ class ActivityObject ); foreach ($sizes as $size) { - $alink = null; $avatar = $profile->getAvatar($size); diff --git a/lib/activityutils.php b/lib/activityutils.php index dd38d4e142..b975a6382b 100644 --- a/lib/activityutils.php +++ b/lib/activityutils.php @@ -46,7 +46,6 @@ if (!defined('STATUSNET')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3 * @link http://status.net/ */ - class ActivityUtils { const ATOM = 'http://www.w3.org/2005/Atom'; @@ -66,7 +65,6 @@ class ActivityUtils * * @return string related link, if any */ - static function getPermalink($element) { return self::getLink($element, 'alternate', 'text/html'); @@ -79,7 +77,6 @@ class ActivityUtils * * @return string related link, if any */ - static function getLink(DOMNode $element, $rel, $type=null) { $els = $element->childNodes; @@ -135,7 +132,6 @@ class ActivityUtils * * @return DOMElement found element or null */ - static function child(DOMNode $element, $tag, $namespace=self::ATOM) { $els = $element->childNodes; @@ -160,7 +156,6 @@ class ActivityUtils * * @return string content of the child */ - static function childContent(DOMNode $element, $tag, $namespace=self::ATOM) { $el = self::child($element, $tag, $namespace); @@ -194,7 +189,6 @@ class ActivityUtils * @todo handle embedded XML mime types * @todo handle base64-encoded non-XML and non-text mime types */ - static function getContent($element) { return self::childHtmlContent($element, self::CONTENT, self::ATOM); @@ -205,6 +199,7 @@ class ActivityUtils $src = $el->getAttribute(self::SRC); if (!empty($src)) { + // TRANS: Client exception thrown when there is no source attribute. throw new ClientException(_("Can't handle remote content yet.")); } @@ -241,10 +236,12 @@ class ActivityUtils return trim($text); } else if (in_array($type, array('text/xml', 'application/xml')) || preg_match('#(+|/)xml$#', $type)) { + // TRANS: Client exception thrown when there embedded XML content is found that cannot be processed yet. throw new ClientException(_("Can't handle embedded XML content yet.")); } else if (strncasecmp($type, 'text/', 5)) { return $el->textContent; } else { + // TRANS: Client exception thrown when base64 encoded content is found that cannot be processed yet. throw new ClientException(_("Can't handle embedded Base64 content yet.")); } } diff --git a/lib/activityverb.php b/lib/activityverb.php index 76f2b84e9c..264351308b 100644 --- a/lib/activityverb.php +++ b/lib/activityverb.php @@ -42,7 +42,6 @@ if (!defined('STATUSNET')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3 * @link http://status.net/ */ - class ActivityVerb { const POST = 'http://activitystrea.ms/schema/1.0/post'; diff --git a/lib/adminform.php b/lib/adminform.php index 3934f63515..9b0e45f8a6 100644 --- a/lib/adminform.php +++ b/lib/adminform.php @@ -45,7 +45,6 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { * * @see Form */ - class AdminForm extends Form { /** @@ -59,7 +58,6 @@ class AdminForm extends Form * * @return void */ - function input($setting, $title, $instructions, $section='site') { $this->out->input($setting, $title, $this->value($setting, $section), $instructions); @@ -73,7 +71,6 @@ class AdminForm extends Form * * @return string param value if posted, or current config value */ - function value($setting, $main='site') { $value = $this->out->trimmed($setting); diff --git a/lib/adminpanelaction.php b/lib/adminpanelaction.php index 41cfe5851b..5c414bbd7b 100644 --- a/lib/adminpanelaction.php +++ b/lib/adminpanelaction.php @@ -44,7 +44,6 @@ if (!defined('STATUSNET')) { * * @todo Find some commonalities with SettingsAction and combine */ - class AdminPanelAction extends Action { var $success = true; @@ -61,7 +60,6 @@ class AdminPanelAction extends Action * * @return boolean success flag */ - function prepare($args) { parent::prepare($args); @@ -124,7 +122,6 @@ class AdminPanelAction extends Action * * @return void */ - function handle($args) { if ($_SERVER['REQUEST_METHOD'] == 'POST') { @@ -155,7 +152,6 @@ class AdminPanelAction extends Action * @return void * @see AdminPanelNav */ - function showLocalNav() { $nav = new AdminPanelNav($this); @@ -169,7 +165,6 @@ class AdminPanelAction extends Action * * @return void. */ - function showContent() { $this->showForm(); @@ -199,7 +194,6 @@ class AdminPanelAction extends Action * * @return void */ - function showPageNotice() { if ($this->msg) { @@ -222,7 +216,6 @@ class AdminPanelAction extends Action * * @return void */ - function showForm() { // TRANS: Client error message. @@ -239,7 +232,6 @@ class AdminPanelAction extends Action * * @return void */ - function getInstructions() { return ''; @@ -252,7 +244,6 @@ class AdminPanelAction extends Action * * @return void */ - function saveSettings() { // TRANS: Client error message @@ -267,7 +258,6 @@ class AdminPanelAction extends Action * * @return mixed $result false if something didn't work */ - function deleteSetting($section, $setting) { $config = new Config(); @@ -314,7 +304,6 @@ class AdminPanelAction extends Action * * @see Widget */ - class AdminPanelNav extends Widget { var $action = null; @@ -324,7 +313,6 @@ class AdminPanelNav extends Widget * * @param Action $action current action, used for output */ - function __construct($action=null) { parent::__construct($action); @@ -336,7 +324,6 @@ class AdminPanelNav extends Widget * * @return void */ - function show() { $action_name = $this->action->trimmed('action'); @@ -413,5 +400,4 @@ class AdminPanelNav extends Widget } $this->action->elementEnd('ul'); } - } diff --git a/lib/apiaction.php b/lib/apiaction.php index 5e0cd55187..0074b7dc53 100644 --- a/lib/apiaction.php +++ b/lib/apiaction.php @@ -112,7 +112,6 @@ if (!defined('STATUSNET')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - class ApiAction extends Action { const READ_ONLY = 1; @@ -139,7 +138,6 @@ class ApiAction extends Action * * @return boolean false if user doesn't exist */ - function prepare($args) { StatusNet::setApi(true); // reduce exception reports to aid in debugging @@ -172,7 +170,6 @@ class ApiAction extends Action * * @return void */ - function handle($args) { header('Access-Control-Allow-Origin: *'); @@ -862,7 +859,6 @@ class ApiAction extends Action } $this->endDocument('atom'); - } function showRssGroups($group, $title, $link, $subtitle) @@ -1015,7 +1011,6 @@ class ApiAction extends Action function showAtomGroups($group, $title, $id, $link, $subtitle=null, $selfuri=null) { - $this->initDocument('atom'); $this->element('title', null, common_xml_safe_str($title)); @@ -1046,7 +1041,6 @@ class ApiAction extends Action function showJsonTimeline($notice) { - $this->initDocument('json'); $statuses = array(); @@ -1072,7 +1066,6 @@ class ApiAction extends Action function showJsonGroups($group) { - $this->initDocument('json'); $groups = array(); @@ -1118,7 +1111,6 @@ class ApiAction extends Action function showTwitterXmlUsers($user) { - $this->initDocument('xml'); $this->elementStart('users', array('type' => 'array', 'xmlns:statusnet' => 'http://status.net/schema/api/1/')); @@ -1141,7 +1133,6 @@ class ApiAction extends Action function showJsonUsers($user) { - $this->initDocument('json'); $users = array(); @@ -1226,7 +1217,6 @@ class ApiAction extends Action $this->endXML(); break; case 'json': - // Check for JSONP callback if (isset($this->callback)) { print ')'; @@ -1483,7 +1473,6 @@ class ApiAction extends Action */ function arg($key, $def=null) { - // XXX: Do even more input validation/scrubbing? if (array_key_exists($key, $this->args)) { @@ -1550,5 +1539,4 @@ class ApiAction extends Action return $uri; } - } diff --git a/lib/apiauth.php b/lib/apiauth.php index cf7a2692ca..8b0a3da17b 100644 --- a/lib/apiauth.php +++ b/lib/apiauth.php @@ -68,7 +68,6 @@ require_once INSTALLDIR . '/lib/apioauth.php'; * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - class ApiAuthAction extends ApiAction { var $auth_user_nickname = null; @@ -83,7 +82,6 @@ class ApiAuthAction extends ApiAction * @return boolean success flag * */ - function prepare($args) { parent::prepare($args); @@ -126,7 +124,6 @@ class ApiAuthAction extends ApiAction * * @return mixed the OAuthRequest or false */ - function getOAuthRequest() { ApiOauthAction::cleanRequest(); @@ -154,7 +151,6 @@ class ApiAuthAction extends ApiAction * * @return nothing */ - function checkOAuthRequest($request) { $datastore = new ApiStatusNetOAuthDataStore(); @@ -164,7 +160,6 @@ class ApiAuthAction extends ApiAction $server->add_signature_method($hmac_method); try { - $server->verify_request($request); $consumer = $request->get_parameter('oauth_consumer_key'); @@ -176,7 +171,8 @@ class ApiAuthAction extends ApiAction common_log(LOG_WARNING, 'Couldn\'t find the OAuth app for consumer key: ' . $consumer); - throw new OAuthException('No application for that consumer key.'); + // TRANS: OAuth exception thrown when no application is found for a given consumer key. + throw new OAuthException(_('No application for that consumer key.')); } // set the source attr @@ -186,19 +182,15 @@ class ApiAuthAction extends ApiAction $appUser = Oauth_application_user::staticGet('token', $access_token); if (!empty($appUser)) { - // If access_type == 0 we have either a request token // or a bad / revoked access token if ($appUser->access_type != 0) { - // Set the access level for the api call - $this->access = ($appUser->access_type & Oauth_application::$writeAccess) ? self::READ_WRITE : self::READ_ONLY; // Set the auth user - if (Event::handle('StartSetApiUser', array(&$user))) { $this->auth_user = User::staticGet('id', $appUser->profile_id); Event::handle('EndSetApiUser', array($user)); @@ -216,13 +208,13 @@ class ApiAuthAction extends ApiAction 'read-write' : 'read-only' )); } else { - throw new OAuthException('Bad access token.'); + // TRANS: OAuth exception given when an incorrect access token was given for a user. + throw new OAuthException(_('Bad access token.')); } } else { - // Also should not happen - - throw new OAuthException('No user for that token.'); + // TRANS: OAuth exception given when no user was found for a given token (no token was found). + throw new OAuthException(_('No user for that token.')); } } catch (OAuthException $e) { @@ -237,7 +229,6 @@ class ApiAuthAction extends ApiAction * * @return boolean true */ - function requiresAuth() { return true; @@ -249,7 +240,6 @@ class ApiAuthAction extends ApiAction * * @return boolean true or false */ - function checkBasicAuthUser($required = true) { $this->basicAuthProcessHeader(); @@ -264,8 +254,8 @@ class ApiAuthAction extends ApiAction header('WWW-Authenticate: Basic realm="' . $realm . '"'); // show error if the user clicks 'cancel' - - $this->clientError("Could not authenticate you.", 401, $this->format); + // TRANS: Client error thrown when authentication fails becaus a user clicked "Cancel". + $this->clientError(_("Could not authenticate you."), 401, $this->format); exit; } else { @@ -283,13 +273,11 @@ class ApiAuthAction extends ApiAction } // By default, basic auth users have rw access - $this->access = self::READ_WRITE; if (empty($this->auth_user) && ($required || isset($_SERVER['PHP_AUTH_USER']))) { // basic authentication failed - list($proxy, $ip) = common_client_ip(); $msg = sprintf( 'Failed API auth attempt, nickname = %1$s, ' . @@ -298,7 +286,8 @@ class ApiAuthAction extends ApiAction $proxy, $ip); common_log(LOG_WARNING, $msg); - $this->clientError("Could not authenticate you.", 401, $this->format); + // TRANS: Client error thrown when authentication fails. + $this->clientError(_("Could not authenticate you."), 401, $this->format); exit; } } @@ -310,7 +299,6 @@ class ApiAuthAction extends ApiAction * * @return void */ - function basicAuthProcessHeader() { $authHeaders = array('AUTHORIZATION', @@ -332,7 +320,6 @@ class ApiAuthAction extends ApiAction // Decode the HTTP_AUTHORIZATION header on php-cgi server self // on fcgid server the header name is AUTHORIZATION - $auth_hash = base64_decode(substr($authorization_header, 6)); list($this->auth_user_nickname, $this->auth_user_password) = explode(':', $auth_hash); diff --git a/lib/attachmentnoticesection.php b/lib/attachmentnoticesection.php index 578c171ff5..53a3b63c1c 100644 --- a/lib/attachmentnoticesection.php +++ b/lib/attachmentnoticesection.php @@ -64,6 +64,7 @@ class AttachmentNoticeSection extends NoticeSection function title() { + // TRANS: Title. return _('Notices where this attachment appears'); } diff --git a/lib/attachmenttagcloudsection.php b/lib/attachmenttagcloudsection.php index e2f85ae025..15aa6dedc3 100644 --- a/lib/attachmenttagcloudsection.php +++ b/lib/attachmenttagcloudsection.php @@ -45,6 +45,7 @@ class AttachmentTagCloudSection extends TagCloudSection { function title() { + // TRANS: Title. return _('Tags for this attachment'); } -- 2.39.5