Rewriting some TODO comments as @todo

This commit is contained in:
Andrew McMillan 2011-08-26 01:03:13 +12:00
parent 6cdd4bc398
commit b4dfa9c1bf
10 changed files with 11 additions and 12 deletions

View File

@ -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.

View File

@ -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 );

View File

@ -1,5 +1,5 @@
<?php
/** @TODO: work out something more than true/false returns for dependency checks */
/** todo work out something more than true/false returns for dependency checks */
function i18n($value) {
return $value; /* Just pass the value through */

View File

@ -314,7 +314,7 @@ EOSQL;
}
}
else if ( $this->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;

View File

@ -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';
}

View File

@ -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);

View File

@ -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 ) {

View File

@ -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');

View File

@ -341,6 +341,5 @@ $d = new iSchedule ();
if ( $d->validateRequest ( ) )
{
include ( 'caldav-POST.php' );
// TODO
// handle request.
// @todo handle request.
}

View File

@ -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 );