From b4dfa9c1bfad0c426e5cc51ade92b0a858bf74f8 Mon Sep 17 00:00:00 2001 From: Andrew McMillan Date: Fri, 26 Aug 2011 01:03:13 +1200 Subject: [PATCH] Rewriting some TODO comments as @todo --- config/example-config.php | 2 +- htdocs/caldav.php | 2 +- htdocs/setup.php | 2 +- inc/CalDAVRequest.php | 2 +- inc/WritableCollection.php | 4 ++-- inc/caldav-LOCK.php | 2 +- inc/caldav-MOVE.php | 2 +- inc/caldav-POST.php | 2 +- inc/iSchedule.php | 3 +-- inc/vcard.php | 2 +- 10 files changed, 11 insertions(+), 12 deletions(-) diff --git a/config/example-config.php b/config/example-config.php index f0c2e851..ce8fc64f 100644 --- a/config/example-config.php +++ b/config/example-config.php @@ -33,7 +33,7 @@ $c->pg_connect[] = "dbname=davical user=davical_app"; /** * default: true -* If true, then TODO requested from someone other than the admmin or owner +* If true, then VTODO requested from someone other than the admmin or owner * of a calendar will not get any answer. Often these todo are only relevant * to the owner, but in some shared calendar situations they might not be in * which case you should set this to false. diff --git a/htdocs/caldav.php b/htdocs/caldav.php index 1bdff495..53248e89 100644 --- a/htdocs/caldav.php +++ b/htdocs/caldav.php @@ -93,7 +93,7 @@ $allowed = implode( ', ', array_keys($request->supported_methods) ); if ( ! ($request->IsPrincipal() || isset($request->collection) || $request->method == 'PUT' || $request->method == 'MKCALENDAR' || $request->method == 'MKCOL' ) ) { if ( preg_match( '#^/principals/users(/.*/)$#', $request->path, $matches ) ) { // Although this doesn't work with the iPhone, perhaps it will with iCal... - /** @TODO: integrate handling this URL into CalDAVRequest.php */ + /** @todo integrate handling this URL into CalDAVRequest.php */ $redirect_url = ConstructURL('/caldav.php'.$matches[1]); dbg_error_log( 'LOG WARNING', 'Redirecting %s for "%s" to "%s"', $request->method, $request->path, $redirect_url ); header('Location: '.$redirect_url ); diff --git a/htdocs/setup.php b/htdocs/setup.php index a45063e4..beb1522c 100644 --- a/htdocs/setup.php +++ b/htdocs/setup.php @@ -1,5 +1,5 @@ options['allow_by_email'] && preg_match( '#^/(\S+@\S+[.]\S+)/?$#', $this->path) ) { - /** @TODO: we should deprecate this now that Evolution 2.27 can do scheduling extensions */ + /** @todo we should deprecate this now that Evolution 2.27 can do scheduling extensions */ $this->collection_id = -1; $this->collection_type = 'email'; $this->collection_path = $this->path; diff --git a/inc/WritableCollection.php b/inc/WritableCollection.php index b5438d5a..0dd63d3b 100644 --- a/inc/WritableCollection.php +++ b/inc/WritableCollection.php @@ -18,7 +18,7 @@ class WritableCollection extends DAVResource { $resources = $ic->GetComponents('VTIMEZONE',false); // Not matching VTIMEZONE if ( !isset($resources[0]) ) { $resource_type = 'Unknown'; - /** @TODO: Handle writing non-calendar resources, like address book entries or random file data */ + /** @todo Handle writing non-calendar resources, like address book entries or random file data */ rollback_on_error( $caldav_context, $user_no, $path, translate('No calendar content'), 412 ); return false; } @@ -121,7 +121,7 @@ class WritableCollection extends DAVResource { $class = $first->GetPValue('CLASS'); /* Check and see if we should over ride the class. */ - /** @TODO: is there some way we can move this out of this function? Or at least get rid of the need for the SQL query here. */ + /** @todo is there some way we can move this out of this function? Or at least get rid of the need for the SQL query here. */ if ( public_events_only($user_no, $path) ) { $class = 'PUBLIC'; } diff --git a/inc/caldav-LOCK.php b/inc/caldav-LOCK.php index 33daa497..92d75d82 100644 --- a/inc/caldav-LOCK.php +++ b/inc/caldav-LOCK.php @@ -143,7 +143,7 @@ if ( $request->method == "LOCK" ) { } elseif ( $request->method == "UNLOCK" ) { /** - * @TODO: respond with preconditionfailed(409,'lock-token-matches-request-uri') if + * @todo respond with preconditionfailed(409,'lock-token-matches-request-uri') if * there is no lock to be deleted. */ dbg_error_log( "LOCK", "Attempting to unlock resource '%s'", $request->path); diff --git a/inc/caldav-MOVE.php b/inc/caldav-MOVE.php index e1bd49ac..bf565461 100644 --- a/inc/caldav-MOVE.php +++ b/inc/caldav-MOVE.php @@ -119,7 +119,7 @@ if ( $src->IsCollection() ) { $qry = new AwlQuery( 'DELETE FROM collection WHERE dav_name = :dst_name', array( ':dst_name' => $dst_name ) ); if ( !$qry->Exec('move') ) rollback(500); } - /** @TODO: Need to confirm this will work correctly if we move this into another user's hierarchy. */ + /** @todo Need to confirm this will work correctly if we move this into another user's hierarchy. */ $sql = 'UPDATE collection SET dav_name = :dst_name '; $params = array(':dst_name' => $dst_name); if ( $src_user_no != $dst_user_no ) { diff --git a/inc/caldav-POST.php b/inc/caldav-POST.php index 0de06895..aef5b9dd 100644 --- a/inc/caldav-POST.php +++ b/inc/caldav-POST.php @@ -60,7 +60,7 @@ function handle_freebusy_request( $ic ) { $attendee_email = preg_replace( '/^mailto:/', '', $attendee->Value() ); dbg_error_log( "POST", "Calculating free/busy for %s", $attendee_email ); - /** @TODO: Refactor this so we only do one query here and loop through the results */ + /** @todo Refactor this so we only do one query here and loop through the results */ $params = array( ':session_principal' => $session->principal_id, ':scan_depth' => $c->permission_scan_depth, ':email' => $attendee_email ); $qry = new AwlQuery('SELECT pprivs(:session_principal::int8,principal_id,:scan_depth::int) AS p, username FROM usr JOIN principal USING(user_no) WHERE lower(usr.email) = lower(:email)', $params ); if ( !$qry->Exec('POST',__LINE__,__FILE__) ) $request->DoResponse( 501, 'Database error'); diff --git a/inc/iSchedule.php b/inc/iSchedule.php index 71fd3895..c62e70aa 100644 --- a/inc/iSchedule.php +++ b/inc/iSchedule.php @@ -341,6 +341,5 @@ $d = new iSchedule (); if ( $d->validateRequest ( ) ) { include ( 'caldav-POST.php' ); - // TODO - // handle request. + // @todo handle request. } diff --git a/inc/vcard.php b/inc/vcard.php index b34869b2..f9a65826 100644 --- a/inc/vcard.php +++ b/inc/vcard.php @@ -52,7 +52,7 @@ VALUES( :dav_id, :version, :uid, :nickname, :fn, :name, :note, :org, :url, :fbur foreach( $properties AS $k => $v ) { $pname = ':' . strtolower($v->Name()); if ( $pname == ':n' ) $pname = ':name'; - if ( !isset($params[$pname]) /** @TODO: or this is one is in the user's language */ ) $params[$pname] = $v->Value(); + if ( !isset($params[$pname]) /** @todo or this is one is in the user's language */ ) $params[$pname] = $v->Value(); } $qry->QDo( $sql, $params );