Datasets:

unum-cloud

/

ann-codesearch-4m

like 0

Follow

Unum 28

[ "public", "function", "initialize", "(", "Server", "$", "server", ")", "{", "$", "server", "->", "resourceTypeMapping", "[", "'Sabre\\\\CalDAV\\\\Subscriptions\\\\ISubscription'", "]", "=", "'{http://calendarserver.org/ns/}subscribed'", ";", "$", "server", "->", "xml", "->", "elementMap", "[", "'{http://calendarserver.org/ns/}source'", "]", "=", "'Sabre\\\\DAV\\\\Xml\\\\Property\\\\Href'", ";", "$", "server", "->", "on", "(", "'propFind'", ",", "[", "$", "this", ",", "'propFind'", "]", ",", "150", ")", ";", "}" ]

[ "This", "initializes", "the", "plugin", "." ]

[ "public", "function", "propFind", "(", "PropFind", "$", "propFind", ",", "INode", "$", "node", ")", "{", "// There's a bunch of properties that must appear as a self-closing", "// xml-element. This event handler ensures that this will be the case.", "$", "props", "=", "[", "'{http://calendarserver.org/ns/}subscribed-strip-alarms'", ",", "'{http://calendarserver.org/ns/}subscribed-strip-attachments'", ",", "'{http://calendarserver.org/ns/}subscribed-strip-todos'", ",", "]", ";", "foreach", "(", "$", "props", "as", "$", "prop", ")", "{", "if", "(", "200", "===", "$", "propFind", "->", "getStatus", "(", "$", "prop", ")", ")", "{", "$", "propFind", "->", "set", "(", "$", "prop", ",", "''", ",", "200", ")", ";", "}", "}", "}" ]

[ "Triggered", "after", "properties", "have", "been", "fetched", "." ]

[ "public", "function", "xmlSerialize", "(", "Writer", "$", "writer", ")", "{", "foreach", "(", "$", "this", "->", "emails", "as", "$", "email", ")", "{", "$", "writer", "->", "writeElement", "(", "'{http://calendarserver.org/ns/}email-address'", ",", "$", "email", ")", ";", "}", "}" ]

[ "The", "xmlSerialize", "method", "is", "called", "during", "xml", "writing", "." ]

[ "public", "function", "initialize", "(", "Server", "$", "server", ")", "{", "$", "this", "->", "server", "=", "$", "server", ";", "$", "server", "->", "on", "(", "'method:POST'", ",", "[", "$", "this", ",", "'httpPost'", "]", ")", ";", "$", "server", "->", "on", "(", "'propFind'", ",", "[", "$", "this", ",", "'propFind'", "]", ")", ";", "$", "server", "->", "on", "(", "'propPatch'", ",", "[", "$", "this", ",", "'propPatch'", "]", ")", ";", "$", "server", "->", "on", "(", "'calendarObjectChange'", ",", "[", "$", "this", ",", "'calendarObjectChange'", "]", ")", ";", "$", "server", "->", "on", "(", "'beforeUnbind'", ",", "[", "$", "this", ",", "'beforeUnbind'", "]", ")", ";", "$", "server", "->", "on", "(", "'schedule'", ",", "[", "$", "this", ",", "'scheduleLocalDelivery'", "]", ")", ";", "$", "server", "->", "on", "(", "'getSupportedPrivilegeSet'", ",", "[", "$", "this", ",", "'getSupportedPrivilegeSet'", "]", ")", ";", "$", "ns", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}'", ";", "/*\n * This information ensures that the {DAV:}resourcetype property has\n * the correct values.\n */", "$", "server", "->", "resourceTypeMapping", "[", "'\\\\Sabre\\\\CalDAV\\\\Schedule\\\\IOutbox'", "]", "=", "$", "ns", ".", "'schedule-outbox'", ";", "$", "server", "->", "resourceTypeMapping", "[", "'\\\\Sabre\\\\CalDAV\\\\Schedule\\\\IInbox'", "]", "=", "$", "ns", ".", "'schedule-inbox'", ";", "/*\n * Properties we protect are made read-only by the server.\n */", "array_push", "(", "$", "server", "->", "protectedProperties", ",", "$", "ns", ".", "'schedule-inbox-URL'", ",", "$", "ns", ".", "'schedule-outbox-URL'", ",", "$", "ns", ".", "'calendar-user-address-set'", ",", "$", "ns", ".", "'calendar-user-type'", ",", "$", "ns", ".", "'schedule-default-calendar-URL'", ")", ";", "}" ]

[ "Initializes", "the", "plugin", "." ]

[ "public", "function", "getHTTPMethods", "(", "$", "uri", ")", "{", "try", "{", "$", "node", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "uri", ")", ";", "}", "catch", "(", "NotFound", "$", "e", ")", "{", "return", "[", "]", ";", "}", "if", "(", "$", "node", "instanceof", "IOutbox", ")", "{", "return", "[", "'POST'", "]", ";", "}", "return", "[", "]", ";", "}" ]

[ "Use", "this", "method", "to", "tell", "the", "server", "this", "plugin", "defines", "additional", "HTTP", "methods", "." ]

[ "public", "function", "httpPost", "(", "RequestInterface", "$", "request", ",", "ResponseInterface", "$", "response", ")", "{", "// Checking if this is a text/calendar content type", "$", "contentType", "=", "$", "request", "->", "getHeader", "(", "'Content-Type'", ")", ";", "if", "(", "!", "$", "contentType", "||", "0", "!==", "strpos", "(", "$", "contentType", ",", "'text/calendar'", ")", ")", "{", "return", ";", "}", "$", "path", "=", "$", "request", "->", "getPath", "(", ")", ";", "// Checking if we're talking to an outbox", "try", "{", "$", "node", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "path", ")", ";", "}", "catch", "(", "NotFound", "$", "e", ")", "{", "return", ";", "}", "if", "(", "!", "$", "node", "instanceof", "IOutbox", ")", "{", "return", ";", "}", "$", "this", "->", "server", "->", "transactionType", "=", "'post-caldav-outbox'", ";", "$", "this", "->", "outboxRequest", "(", "$", "node", ",", "$", "request", ",", "$", "response", ")", ";", "// Returning false breaks the event chain and tells the server we've", "// handled the request.", "return", "false", ";", "}" ]

[ "This", "method", "handles", "POST", "request", "for", "the", "outbox", "." ]

[ "public", "function", "propFind", "(", "PropFind", "$", "propFind", ",", "INode", "$", "node", ")", "{", "if", "(", "$", "node", "instanceof", "DAVACL", "\\", "IPrincipal", ")", "{", "$", "caldavPlugin", "=", "$", "this", "->", "server", "->", "getPlugin", "(", "'caldav'", ")", ";", "$", "principalUrl", "=", "$", "node", "->", "getPrincipalUrl", "(", ")", ";", "// schedule-outbox-URL property", "$", "propFind", "->", "handle", "(", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}schedule-outbox-URL'", ",", "function", "(", ")", "use", "(", "$", "principalUrl", ",", "$", "caldavPlugin", ")", "{", "$", "calendarHomePath", "=", "$", "caldavPlugin", "->", "getCalendarHomeForPrincipal", "(", "$", "principalUrl", ")", ";", "if", "(", "!", "$", "calendarHomePath", ")", "{", "return", "null", ";", "}", "$", "outboxPath", "=", "$", "calendarHomePath", ".", "'/outbox/'", ";", "return", "new", "LocalHref", "(", "$", "outboxPath", ")", ";", "}", ")", ";", "// schedule-inbox-URL property", "$", "propFind", "->", "handle", "(", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}schedule-inbox-URL'", ",", "function", "(", ")", "use", "(", "$", "principalUrl", ",", "$", "caldavPlugin", ")", "{", "$", "calendarHomePath", "=", "$", "caldavPlugin", "->", "getCalendarHomeForPrincipal", "(", "$", "principalUrl", ")", ";", "if", "(", "!", "$", "calendarHomePath", ")", "{", "return", "null", ";", "}", "$", "inboxPath", "=", "$", "calendarHomePath", ".", "'/inbox/'", ";", "return", "new", "LocalHref", "(", "$", "inboxPath", ")", ";", "}", ")", ";", "$", "propFind", "->", "handle", "(", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}schedule-default-calendar-URL'", ",", "function", "(", ")", "use", "(", "$", "principalUrl", ",", "$", "caldavPlugin", ")", "{", "// We don't support customizing this property yet, so in the", "// meantime we just grab the first calendar in the home-set.", "$", "calendarHomePath", "=", "$", "caldavPlugin", "->", "getCalendarHomeForPrincipal", "(", "$", "principalUrl", ")", ";", "if", "(", "!", "$", "calendarHomePath", ")", "{", "return", "null", ";", "}", "$", "sccs", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}supported-calendar-component-set'", ";", "$", "result", "=", "$", "this", "->", "server", "->", "getPropertiesForPath", "(", "$", "calendarHomePath", ",", "[", "'{DAV:}resourcetype'", ",", "'{DAV:}share-access'", ",", "$", "sccs", ",", "]", ",", "1", ")", ";", "foreach", "(", "$", "result", "as", "$", "child", ")", "{", "if", "(", "!", "isset", "(", "$", "child", "[", "200", "]", "[", "'{DAV:}resourcetype'", "]", ")", "||", "!", "$", "child", "[", "200", "]", "[", "'{DAV:}resourcetype'", "]", "->", "is", "(", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}calendar'", ")", ")", "{", "// Node is either not a calendar", "continue", ";", "}", "if", "(", "isset", "(", "$", "child", "[", "200", "]", "[", "'{DAV:}share-access'", "]", ")", ")", "{", "$", "shareAccess", "=", "$", "child", "[", "200", "]", "[", "'{DAV:}share-access'", "]", "->", "getValue", "(", ")", ";", "if", "(", "Sharing", "\\", "Plugin", "::", "ACCESS_NOTSHARED", "!==", "$", "shareAccess", "&&", "Sharing", "\\", "Plugin", "::", "ACCESS_SHAREDOWNER", "!==", "$", "shareAccess", ")", "{", "// Node is a shared node, not owned by the relevant", "// user.", "continue", ";", "}", "}", "if", "(", "!", "isset", "(", "$", "child", "[", "200", "]", "[", "$", "sccs", "]", ")", "||", "in_array", "(", "'VEVENT'", ",", "$", "child", "[", "200", "]", "[", "$", "sccs", "]", "->", "getValue", "(", ")", ")", ")", "{", "// Either there is no supported-calendar-component-set", "// (which is fine) or we found one that supports VEVENT.", "return", "new", "LocalHref", "(", "$", "child", "[", "'href'", "]", ")", ";", "}", "}", "}", ")", ";", "// The server currently reports every principal to be of type", "// 'INDIVIDUAL'", "$", "propFind", "->", "handle", "(", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}calendar-user-type'", ",", "function", "(", ")", "{", "return", "'INDIVIDUAL'", ";", "}", ")", ";", "}", "// Mapping the old property to the new property.", "$", "propFind", "->", "handle", "(", "'{http://calendarserver.org/ns/}calendar-availability'", ",", "function", "(", ")", "use", "(", "$", "propFind", ",", "$", "node", ")", "{", "// In case it wasn't clear, the only difference is that we map the", "// old property to a different namespace.", "$", "availProp", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}calendar-availability'", ";", "$", "subPropFind", "=", "new", "PropFind", "(", "$", "propFind", "->", "getPath", "(", ")", ",", "[", "$", "availProp", "]", ")", ";", "$", "this", "->", "server", "->", "getPropertiesByNode", "(", "$", "subPropFind", ",", "$", "node", ")", ";", "$", "propFind", "->", "set", "(", "'{http://calendarserver.org/ns/}calendar-availability'", ",", "$", "subPropFind", "->", "get", "(", "$", "availProp", ")", ",", "$", "subPropFind", "->", "getStatus", "(", "$", "availProp", ")", ")", ";", "}", ")", ";", "}" ]

[ "This", "method", "handler", "is", "invoked", "during", "fetching", "of", "properties", "." ]

[ "public", "function", "propPatch", "(", "$", "path", ",", "PropPatch", "$", "propPatch", ")", "{", "// Mapping the old property to the new property.", "$", "propPatch", "->", "handle", "(", "'{http://calendarserver.org/ns/}calendar-availability'", ",", "function", "(", "$", "value", ")", "use", "(", "$", "path", ")", "{", "$", "availProp", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}calendar-availability'", ";", "$", "subPropPatch", "=", "new", "PropPatch", "(", "[", "$", "availProp", "=>", "$", "value", "]", ")", ";", "$", "this", "->", "server", "->", "emit", "(", "'propPatch'", ",", "[", "$", "path", ",", "$", "subPropPatch", "]", ")", ";", "$", "subPropPatch", "->", "commit", "(", ")", ";", "return", "$", "subPropPatch", "->", "getResult", "(", ")", "[", "$", "availProp", "]", ";", "}", ")", ";", "}" ]

[ "This", "method", "is", "called", "during", "property", "updates", "." ]

[ "public", "function", "calendarObjectChange", "(", "RequestInterface", "$", "request", ",", "ResponseInterface", "$", "response", ",", "VCalendar", "$", "vCal", ",", "$", "calendarPath", ",", "&", "$", "modified", ",", "$", "isNew", ")", "{", "if", "(", "!", "$", "this", "->", "scheduleReply", "(", "$", "this", "->", "server", "->", "httpRequest", ")", ")", "{", "return", ";", "}", "$", "calendarNode", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "calendarPath", ")", ";", "$", "addresses", "=", "$", "this", "->", "getAddressesForPrincipal", "(", "$", "calendarNode", "->", "getOwner", "(", ")", ")", ";", "if", "(", "!", "$", "isNew", ")", "{", "$", "node", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "request", "->", "getPath", "(", ")", ")", ";", "$", "oldObj", "=", "Reader", "::", "read", "(", "$", "node", "->", "get", "(", ")", ")", ";", "}", "else", "{", "$", "oldObj", "=", "null", ";", "}", "$", "this", "->", "processICalendarChange", "(", "$", "oldObj", ",", "$", "vCal", ",", "$", "addresses", ",", "[", "]", ",", "$", "modified", ")", ";", "if", "(", "$", "oldObj", ")", "{", "// Destroy circular references so PHP will GC the object.", "$", "oldObj", "->", "destroy", "(", ")", ";", "}", "}" ]

[ "This", "method", "is", "triggered", "whenever", "there", "was", "a", "calendar", "object", "gets", "created", "or", "updated", "." ]

[ "public", "function", "deliver", "(", "ITip", "\\", "Message", "$", "iTipMessage", ")", "{", "$", "this", "->", "server", "->", "emit", "(", "'schedule'", ",", "[", "$", "iTipMessage", "]", ")", ";", "if", "(", "!", "$", "iTipMessage", "->", "scheduleStatus", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "'5.2;There was no system capable of delivering the scheduling message'", ";", "}", "// In case the change was considered 'insignificant', we are going to", "// remove any error statuses, if any. See ticket #525.", "list", "(", "$", "baseCode", ")", "=", "explode", "(", "'.'", ",", "$", "iTipMessage", "->", "scheduleStatus", ")", ";", "if", "(", "!", "$", "iTipMessage", "->", "significantChange", "&&", "in_array", "(", "$", "baseCode", ",", "[", "'3'", ",", "'5'", "]", ")", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "null", ";", "}", "}" ]

[ "This", "method", "is", "responsible", "for", "delivering", "the", "ITip", "message", "." ]

[ "public", "function", "beforeUnbind", "(", "$", "path", ")", "{", "// FIXME: We shouldn't trigger this functionality when we're issuing a", "// MOVE. This is a hack.", "if", "(", "'MOVE'", "===", "$", "this", "->", "server", "->", "httpRequest", "->", "getMethod", "(", ")", ")", "{", "return", ";", "}", "$", "node", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "path", ")", ";", "if", "(", "!", "$", "node", "instanceof", "ICalendarObject", "||", "$", "node", "instanceof", "ISchedulingObject", ")", "{", "return", ";", "}", "if", "(", "!", "$", "this", "->", "scheduleReply", "(", "$", "this", "->", "server", "->", "httpRequest", ")", ")", "{", "return", ";", "}", "$", "addresses", "=", "$", "this", "->", "getAddressesForPrincipal", "(", "$", "node", "->", "getOwner", "(", ")", ")", ";", "$", "broker", "=", "new", "ITip", "\\", "Broker", "(", ")", ";", "$", "messages", "=", "$", "broker", "->", "parseEvent", "(", "null", ",", "$", "addresses", ",", "$", "node", "->", "get", "(", ")", ")", ";", "foreach", "(", "$", "messages", "as", "$", "message", ")", "{", "$", "this", "->", "deliver", "(", "$", "message", ")", ";", "}", "}" ]

[ "This", "method", "is", "triggered", "before", "a", "file", "gets", "deleted", "." ]

[ "public", "function", "scheduleLocalDelivery", "(", "ITip", "\\", "Message", "$", "iTipMessage", ")", "{", "$", "aclPlugin", "=", "$", "this", "->", "server", "->", "getPlugin", "(", "'acl'", ")", ";", "// Local delivery is not available if the ACL plugin is not loaded.", "if", "(", "!", "$", "aclPlugin", ")", "{", "return", ";", "}", "$", "caldavNS", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}'", ";", "$", "principalUri", "=", "$", "aclPlugin", "->", "getPrincipalByUri", "(", "$", "iTipMessage", "->", "recipient", ")", ";", "if", "(", "!", "$", "principalUri", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "'3.7;Could not find principal.'", ";", "return", ";", "}", "// We found a principal URL, now we need to find its inbox.", "// Unfortunately we may not have sufficient privileges to find this, so", "// we are temporarily turning off ACL to let this come through.", "//", "// Once we support PHP 5.5, this should be wrapped in a try..finally", "// block so we can ensure that this privilege gets added again after.", "$", "this", "->", "server", "->", "removeListener", "(", "'propFind'", ",", "[", "$", "aclPlugin", ",", "'propFind'", "]", ")", ";", "$", "result", "=", "$", "this", "->", "server", "->", "getProperties", "(", "$", "principalUri", ",", "[", "'{DAV:}principal-URL'", ",", "$", "caldavNS", ".", "'calendar-home-set'", ",", "$", "caldavNS", ".", "'schedule-inbox-URL'", ",", "$", "caldavNS", ".", "'schedule-default-calendar-URL'", ",", "'{http://sabredav.org/ns}email-address'", ",", "]", ")", ";", "// Re-registering the ACL event", "$", "this", "->", "server", "->", "on", "(", "'propFind'", ",", "[", "$", "aclPlugin", ",", "'propFind'", "]", ",", "20", ")", ";", "if", "(", "!", "isset", "(", "$", "result", "[", "$", "caldavNS", ".", "'schedule-inbox-URL'", "]", ")", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "'5.2;Could not find local inbox'", ";", "return", ";", "}", "if", "(", "!", "isset", "(", "$", "result", "[", "$", "caldavNS", ".", "'calendar-home-set'", "]", ")", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "'5.2;Could not locate a calendar-home-set'", ";", "return", ";", "}", "if", "(", "!", "isset", "(", "$", "result", "[", "$", "caldavNS", ".", "'schedule-default-calendar-URL'", "]", ")", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "'5.2;Could not find a schedule-default-calendar-URL property'", ";", "return", ";", "}", "$", "calendarPath", "=", "$", "result", "[", "$", "caldavNS", ".", "'schedule-default-calendar-URL'", "]", "->", "getHref", "(", ")", ";", "$", "homePath", "=", "$", "result", "[", "$", "caldavNS", ".", "'calendar-home-set'", "]", "->", "getHref", "(", ")", ";", "$", "inboxPath", "=", "$", "result", "[", "$", "caldavNS", ".", "'schedule-inbox-URL'", "]", "->", "getHref", "(", ")", ";", "if", "(", "'REPLY'", "===", "$", "iTipMessage", "->", "method", ")", "{", "$", "privilege", "=", "'schedule-deliver-reply'", ";", "}", "else", "{", "$", "privilege", "=", "'schedule-deliver-invite'", ";", "}", "if", "(", "!", "$", "aclPlugin", "->", "checkPrivileges", "(", "$", "inboxPath", ",", "$", "caldavNS", ".", "$", "privilege", ",", "DAVACL", "\\", "Plugin", "::", "R_PARENT", ",", "false", ")", ")", "{", "$", "iTipMessage", "->", "scheduleStatus", "=", "'3.8;insufficient privileges: '", ".", "$", "privilege", ".", "' is required on the recipient schedule inbox.'", ";", "return", ";", "}", "// Next, we're going to find out if the item already exits in one of", "// the users' calendars.", "$", "uid", "=", "$", "iTipMessage", "->", "uid", ";", "$", "newFileName", "=", "'sabredav-'", ".", "\\", "Sabre", "\\", "DAV", "\\", "UUIDUtil", "::", "getUUID", "(", ")", ".", "'.ics'", ";", "$", "home", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "homePath", ")", ";", "$", "inbox", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "inboxPath", ")", ";", "$", "currentObject", "=", "null", ";", "$", "objectNode", "=", "null", ";", "$", "isNewNode", "=", "false", ";", "$", "result", "=", "$", "home", "->", "getCalendarObjectByUID", "(", "$", "uid", ")", ";", "if", "(", "$", "result", ")", "{", "// There was an existing object, we need to update probably.", "$", "objectPath", "=", "$", "homePath", ".", "'/'", ".", "$", "result", ";", "$", "objectNode", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "objectPath", ")", ";", "$", "oldICalendarData", "=", "$", "objectNode", "->", "get", "(", ")", ";", "$", "currentObject", "=", "Reader", "::", "read", "(", "$", "oldICalendarData", ")", ";", "}", "else", "{", "$", "isNewNode", "=", "true", ";", "}", "$", "broker", "=", "new", "ITip", "\\", "Broker", "(", ")", ";", "$", "newObject", "=", "$", "broker", "->", "processMessage", "(", "$", "iTipMessage", ",", "$", "currentObject", ")", ";", "$", "inbox", "->", "createFile", "(", "$", "newFileName", ",", "$", "iTipMessage", "->", "message", "->", "serialize", "(", ")", ")", ";", "if", "(", "!", "$", "newObject", ")", "{", "// We received an iTip message referring to a UID that we don't", "// have in any calendars yet, and processMessage did not give us a", "// calendarobject back.", "//", "// The implication is that processMessage did not understand the", "// iTip message.", "$", "iTipMessage", "->", "scheduleStatus", "=", "'5.0;iTip message was not processed by the server, likely because we didn\\'t understand it.'", ";", "return", ";", "}", "// Note that we are bypassing ACL on purpose by calling this directly.", "// We may need to look a bit deeper into this later. Supporting ACL", "// here would be nice.", "if", "(", "$", "isNewNode", ")", "{", "$", "calendar", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "calendarPath", ")", ";", "$", "calendar", "->", "createFile", "(", "$", "newFileName", ",", "$", "newObject", "->", "serialize", "(", ")", ")", ";", "}", "else", "{", "// If the message was a reply, we may have to inform other", "// attendees of this attendees status. Therefore we're shooting off", "// another itipMessage.", "if", "(", "'REPLY'", "===", "$", "iTipMessage", "->", "method", ")", "{", "$", "this", "->", "processICalendarChange", "(", "$", "oldICalendarData", ",", "$", "newObject", ",", "[", "$", "iTipMessage", "->", "recipient", "]", ",", "[", "$", "iTipMessage", "->", "sender", "]", ")", ";", "}", "$", "objectNode", "->", "put", "(", "$", "newObject", "->", "serialize", "(", ")", ")", ";", "}", "$", "iTipMessage", "->", "scheduleStatus", "=", "'1.2;Message delivered locally'", ";", "}" ]

[ "Event", "handler", "for", "the", "schedule", "event", "." ]

[ "public", "function", "getSupportedPrivilegeSet", "(", "INode", "$", "node", ",", "array", "&", "$", "supportedPrivilegeSet", ")", "{", "$", "ns", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}'", ";", "if", "(", "$", "node", "instanceof", "IOutbox", ")", "{", "$", "supportedPrivilegeSet", "[", "$", "ns", ".", "'schedule-send'", "]", "=", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "$", "ns", ".", "'schedule-send-invite'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "$", "ns", ".", "'schedule-send-reply'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "$", "ns", ".", "'schedule-send-freebusy'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "// Privilege from an earlier scheduling draft, but still", "// used by some clients.", "$", "ns", ".", "'schedule-post-vevent'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "]", ",", "]", ";", "}", "if", "(", "$", "node", "instanceof", "IInbox", ")", "{", "$", "supportedPrivilegeSet", "[", "$", "ns", ".", "'schedule-deliver'", "]", "=", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "$", "ns", ".", "'schedule-deliver-invite'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "$", "ns", ".", "'schedule-deliver-reply'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "$", "ns", ".", "'schedule-query-freebusy'", "=>", "[", "'abstract'", "=>", "false", ",", "'aggregates'", "=>", "[", "]", ",", "]", ",", "]", ",", "]", ";", "}", "}" ]

[ "This", "method", "is", "triggered", "whenever", "a", "subsystem", "requests", "the", "privileges", "that", "are", "supported", "on", "a", "particular", "node", "." ]

[ "protected", "function", "processICalendarChange", "(", "$", "oldObject", "=", "null", ",", "VCalendar", "$", "newObject", ",", "array", "$", "addresses", ",", "array", "$", "ignore", "=", "[", "]", ",", "&", "$", "modified", "=", "false", ")", "{", "$", "broker", "=", "new", "ITip", "\\", "Broker", "(", ")", ";", "$", "messages", "=", "$", "broker", "->", "parseEvent", "(", "$", "newObject", ",", "$", "addresses", ",", "$", "oldObject", ")", ";", "if", "(", "$", "messages", ")", "{", "$", "modified", "=", "true", ";", "}", "foreach", "(", "$", "messages", "as", "$", "message", ")", "{", "if", "(", "in_array", "(", "$", "message", "->", "recipient", ",", "$", "ignore", ")", ")", "{", "continue", ";", "}", "$", "this", "->", "deliver", "(", "$", "message", ")", ";", "if", "(", "isset", "(", "$", "newObject", "->", "VEVENT", "->", "ORGANIZER", ")", "&&", "(", "$", "newObject", "->", "VEVENT", "->", "ORGANIZER", "->", "getNormalizedValue", "(", ")", "===", "$", "message", "->", "recipient", ")", ")", "{", "if", "(", "$", "message", "->", "scheduleStatus", ")", "{", "$", "newObject", "->", "VEVENT", "->", "ORGANIZER", "[", "'SCHEDULE-STATUS'", "]", "=", "$", "message", "->", "getScheduleStatus", "(", ")", ";", "}", "unset", "(", "$", "newObject", "->", "VEVENT", "->", "ORGANIZER", "[", "'SCHEDULE-FORCE-SEND'", "]", ")", ";", "}", "else", "{", "if", "(", "isset", "(", "$", "newObject", "->", "VEVENT", "->", "ATTENDEE", ")", ")", "{", "foreach", "(", "$", "newObject", "->", "VEVENT", "->", "ATTENDEE", "as", "$", "attendee", ")", "{", "if", "(", "$", "attendee", "->", "getNormalizedValue", "(", ")", "===", "$", "message", "->", "recipient", ")", "{", "if", "(", "$", "message", "->", "scheduleStatus", ")", "{", "$", "attendee", "[", "'SCHEDULE-STATUS'", "]", "=", "$", "message", "->", "getScheduleStatus", "(", ")", ";", "}", "unset", "(", "$", "attendee", "[", "'SCHEDULE-FORCE-SEND'", "]", ")", ";", "break", ";", "}", "}", "}", "}", "}", "}" ]

[ "This", "method", "looks", "at", "an", "old", "iCalendar", "object", "a", "new", "iCalendar", "object", "and", "starts", "sending", "scheduling", "messages", "based", "on", "the", "changes", "." ]

[ "protected", "function", "getAddressesForPrincipal", "(", "$", "principal", ")", "{", "$", "CUAS", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}calendar-user-address-set'", ";", "$", "properties", "=", "$", "this", "->", "server", "->", "getProperties", "(", "$", "principal", ",", "[", "$", "CUAS", "]", ")", ";", "// If we can't find this information, we'll stop processing", "if", "(", "!", "isset", "(", "$", "properties", "[", "$", "CUAS", "]", ")", ")", "{", "return", "[", "]", ";", "}", "$", "addresses", "=", "$", "properties", "[", "$", "CUAS", "]", "->", "getHrefs", "(", ")", ";", "return", "$", "addresses", ";", "}" ]

[ "Returns", "a", "list", "of", "addresses", "that", "are", "associated", "with", "a", "principal", "." ]

[ "public", "function", "outboxRequest", "(", "IOutbox", "$", "outboxNode", ",", "RequestInterface", "$", "request", ",", "ResponseInterface", "$", "response", ")", "{", "$", "outboxPath", "=", "$", "request", "->", "getPath", "(", ")", ";", "// Parsing the request body", "try", "{", "$", "vObject", "=", "VObject", "\\", "Reader", "::", "read", "(", "$", "request", "->", "getBody", "(", ")", ")", ";", "}", "catch", "(", "VObject", "\\", "ParseException", "$", "e", ")", "{", "throw", "new", "BadRequest", "(", "'The request body must be a valid iCalendar object. Parse error: '", ".", "$", "e", "->", "getMessage", "(", ")", ")", ";", "}", "// The incoming iCalendar object must have a METHOD property, and a", "// component. The combination of both determines what type of request", "// this is.", "$", "componentType", "=", "null", ";", "foreach", "(", "$", "vObject", "->", "getComponents", "(", ")", "as", "$", "component", ")", "{", "if", "(", "'VTIMEZONE'", "!==", "$", "component", "->", "name", ")", "{", "$", "componentType", "=", "$", "component", "->", "name", ";", "break", ";", "}", "}", "if", "(", "is_null", "(", "$", "componentType", ")", ")", "{", "throw", "new", "BadRequest", "(", "'We expected at least one VTODO, VJOURNAL, VFREEBUSY or VEVENT component'", ")", ";", "}", "// Validating the METHOD", "$", "method", "=", "strtoupper", "(", "(", "string", ")", "$", "vObject", "->", "METHOD", ")", ";", "if", "(", "!", "$", "method", ")", "{", "throw", "new", "BadRequest", "(", "'A METHOD property must be specified in iTIP messages'", ")", ";", "}", "// So we support one type of request:", "//", "// REQUEST with a VFREEBUSY component", "$", "acl", "=", "$", "this", "->", "server", "->", "getPlugin", "(", "'acl'", ")", ";", "if", "(", "'VFREEBUSY'", "===", "$", "componentType", "&&", "'REQUEST'", "===", "$", "method", ")", "{", "$", "acl", "&&", "$", "acl", "->", "checkPrivileges", "(", "$", "outboxPath", ",", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}schedule-send-freebusy'", ")", ";", "$", "this", "->", "handleFreeBusyRequest", "(", "$", "outboxNode", ",", "$", "vObject", ",", "$", "request", ",", "$", "response", ")", ";", "// Destroy circular references so PHP can GC the object.", "$", "vObject", "->", "destroy", "(", ")", ";", "unset", "(", "$", "vObject", ")", ";", "}", "else", "{", "throw", "new", "NotImplemented", "(", "'We only support VFREEBUSY (REQUEST) on this endpoint'", ")", ";", "}", "}" ]

[ "This", "method", "handles", "POST", "requests", "to", "the", "schedule", "-", "outbox", "." ]

[ "protected", "function", "handleFreeBusyRequest", "(", "IOutbox", "$", "outbox", ",", "VObject", "\\", "Component", "$", "vObject", ",", "RequestInterface", "$", "request", ",", "ResponseInterface", "$", "response", ")", "{", "$", "vFreeBusy", "=", "$", "vObject", "->", "VFREEBUSY", ";", "$", "organizer", "=", "$", "vFreeBusy", "->", "ORGANIZER", ";", "$", "organizer", "=", "(", "string", ")", "$", "organizer", ";", "// Validating if the organizer matches the owner of the inbox.", "$", "owner", "=", "$", "outbox", "->", "getOwner", "(", ")", ";", "$", "caldavNS", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}'", ";", "$", "uas", "=", "$", "caldavNS", ".", "'calendar-user-address-set'", ";", "$", "props", "=", "$", "this", "->", "server", "->", "getProperties", "(", "$", "owner", ",", "[", "$", "uas", "]", ")", ";", "if", "(", "empty", "(", "$", "props", "[", "$", "uas", "]", ")", "||", "!", "in_array", "(", "$", "organizer", ",", "$", "props", "[", "$", "uas", "]", "->", "getHrefs", "(", ")", ")", ")", "{", "throw", "new", "Forbidden", "(", "'The organizer in the request did not match any of the addresses for the owner of this inbox'", ")", ";", "}", "if", "(", "!", "isset", "(", "$", "vFreeBusy", "->", "ATTENDEE", ")", ")", "{", "throw", "new", "BadRequest", "(", "'You must at least specify 1 attendee'", ")", ";", "}", "$", "attendees", "=", "[", "]", ";", "foreach", "(", "$", "vFreeBusy", "->", "ATTENDEE", "as", "$", "attendee", ")", "{", "$", "attendees", "[", "]", "=", "(", "string", ")", "$", "attendee", ";", "}", "if", "(", "!", "isset", "(", "$", "vFreeBusy", "->", "DTSTART", ")", "||", "!", "isset", "(", "$", "vFreeBusy", "->", "DTEND", ")", ")", "{", "throw", "new", "BadRequest", "(", "'DTSTART and DTEND must both be specified'", ")", ";", "}", "$", "startRange", "=", "$", "vFreeBusy", "->", "DTSTART", "->", "getDateTime", "(", ")", ";", "$", "endRange", "=", "$", "vFreeBusy", "->", "DTEND", "->", "getDateTime", "(", ")", ";", "$", "results", "=", "[", "]", ";", "foreach", "(", "$", "attendees", "as", "$", "attendee", ")", "{", "$", "results", "[", "]", "=", "$", "this", "->", "getFreeBusyForEmail", "(", "$", "attendee", ",", "$", "startRange", ",", "$", "endRange", ",", "$", "vObject", ")", ";", "}", "$", "dom", "=", "new", "\\", "DOMDocument", "(", "'1.0'", ",", "'utf-8'", ")", ";", "$", "dom", "->", "formatOutput", "=", "true", ";", "$", "scheduleResponse", "=", "$", "dom", "->", "createElement", "(", "'cal:schedule-response'", ")", ";", "foreach", "(", "$", "this", "->", "server", "->", "xml", "->", "namespaceMap", "as", "$", "namespace", "=>", "$", "prefix", ")", "{", "$", "scheduleResponse", "->", "setAttribute", "(", "'xmlns:'", ".", "$", "prefix", ",", "$", "namespace", ")", ";", "}", "$", "dom", "->", "appendChild", "(", "$", "scheduleResponse", ")", ";", "foreach", "(", "$", "results", "as", "$", "result", ")", "{", "$", "xresponse", "=", "$", "dom", "->", "createElement", "(", "'cal:response'", ")", ";", "$", "recipient", "=", "$", "dom", "->", "createElement", "(", "'cal:recipient'", ")", ";", "$", "recipientHref", "=", "$", "dom", "->", "createElement", "(", "'d:href'", ")", ";", "$", "recipientHref", "->", "appendChild", "(", "$", "dom", "->", "createTextNode", "(", "$", "result", "[", "'href'", "]", ")", ")", ";", "$", "recipient", "->", "appendChild", "(", "$", "recipientHref", ")", ";", "$", "xresponse", "->", "appendChild", "(", "$", "recipient", ")", ";", "$", "reqStatus", "=", "$", "dom", "->", "createElement", "(", "'cal:request-status'", ")", ";", "$", "reqStatus", "->", "appendChild", "(", "$", "dom", "->", "createTextNode", "(", "$", "result", "[", "'request-status'", "]", ")", ")", ";", "$", "xresponse", "->", "appendChild", "(", "$", "reqStatus", ")", ";", "if", "(", "isset", "(", "$", "result", "[", "'calendar-data'", "]", ")", ")", "{", "$", "calendardata", "=", "$", "dom", "->", "createElement", "(", "'cal:calendar-data'", ")", ";", "$", "calendardata", "->", "appendChild", "(", "$", "dom", "->", "createTextNode", "(", "str_replace", "(", "\"\\r\\n\"", ",", "\"\\n\"", ",", "$", "result", "[", "'calendar-data'", "]", "->", "serialize", "(", ")", ")", ")", ")", ";", "$", "xresponse", "->", "appendChild", "(", "$", "calendardata", ")", ";", "}", "$", "scheduleResponse", "->", "appendChild", "(", "$", "xresponse", ")", ";", "}", "$", "response", "->", "setStatus", "(", "200", ")", ";", "$", "response", "->", "setHeader", "(", "'Content-Type'", ",", "'application/xml'", ")", ";", "$", "response", "->", "setBody", "(", "$", "dom", "->", "saveXML", "(", ")", ")", ";", "}" ]

[ "This", "method", "is", "responsible", "for", "parsing", "a", "free", "-", "busy", "query", "request", "and", "returning", "it", "s", "result", "." ]

[ "protected", "function", "getFreeBusyForEmail", "(", "$", "email", ",", "\\", "DateTimeInterface", "$", "start", ",", "\\", "DateTimeInterface", "$", "end", ",", "VObject", "\\", "Component", "$", "request", ")", "{", "$", "caldavNS", "=", "'{'", ".", "self", "::", "NS_CALDAV", ".", "'}'", ";", "$", "aclPlugin", "=", "$", "this", "->", "server", "->", "getPlugin", "(", "'acl'", ")", ";", "if", "(", "'mailto:'", "===", "substr", "(", "$", "email", ",", "0", ",", "7", ")", ")", "{", "$", "email", "=", "substr", "(", "$", "email", ",", "7", ")", ";", "}", "$", "result", "=", "$", "aclPlugin", "->", "principalSearch", "(", "[", "'{http://sabredav.org/ns}email-address'", "=>", "$", "email", "]", ",", "[", "'{DAV:}principal-URL'", ",", "$", "caldavNS", ".", "'calendar-home-set'", ",", "$", "caldavNS", ".", "'schedule-inbox-URL'", ",", "'{http://sabredav.org/ns}email-address'", ",", "]", ")", ";", "if", "(", "!", "count", "(", "$", "result", ")", ")", "{", "return", "[", "'request-status'", "=>", "'3.7;Could not find principal'", ",", "'href'", "=>", "'mailto:'", ".", "$", "email", ",", "]", ";", "}", "if", "(", "!", "isset", "(", "$", "result", "[", "0", "]", "[", "200", "]", "[", "$", "caldavNS", ".", "'calendar-home-set'", "]", ")", ")", "{", "return", "[", "'request-status'", "=>", "'3.7;No calendar-home-set property found'", ",", "'href'", "=>", "'mailto:'", ".", "$", "email", ",", "]", ";", "}", "if", "(", "!", "isset", "(", "$", "result", "[", "0", "]", "[", "200", "]", "[", "$", "caldavNS", ".", "'schedule-inbox-URL'", "]", ")", ")", "{", "return", "[", "'request-status'", "=>", "'3.7;No schedule-inbox-URL property found'", ",", "'href'", "=>", "'mailto:'", ".", "$", "email", ",", "]", ";", "}", "$", "homeSet", "=", "$", "result", "[", "0", "]", "[", "200", "]", "[", "$", "caldavNS", ".", "'calendar-home-set'", "]", "->", "getHref", "(", ")", ";", "$", "inboxUrl", "=", "$", "result", "[", "0", "]", "[", "200", "]", "[", "$", "caldavNS", ".", "'schedule-inbox-URL'", "]", "->", "getHref", "(", ")", ";", "// Do we have permission?", "$", "aclPlugin", "->", "checkPrivileges", "(", "$", "inboxUrl", ",", "$", "caldavNS", ".", "'schedule-query-freebusy'", ")", ";", "// Grabbing the calendar list", "$", "objects", "=", "[", "]", ";", "$", "calendarTimeZone", "=", "new", "DateTimeZone", "(", "'UTC'", ")", ";", "foreach", "(", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "homeSet", ")", "->", "getChildren", "(", ")", "as", "$", "node", ")", "{", "if", "(", "!", "$", "node", "instanceof", "ICalendar", ")", "{", "continue", ";", "}", "$", "sct", "=", "$", "caldavNS", ".", "'schedule-calendar-transp'", ";", "$", "ctz", "=", "$", "caldavNS", ".", "'calendar-timezone'", ";", "$", "props", "=", "$", "node", "->", "getProperties", "(", "[", "$", "sct", ",", "$", "ctz", "]", ")", ";", "if", "(", "isset", "(", "$", "props", "[", "$", "sct", "]", ")", "&&", "ScheduleCalendarTransp", "::", "TRANSPARENT", "==", "$", "props", "[", "$", "sct", "]", "->", "getValue", "(", ")", ")", "{", "// If a calendar is marked as 'transparent', it means we must", "// ignore it for free-busy purposes.", "continue", ";", "}", "if", "(", "isset", "(", "$", "props", "[", "$", "ctz", "]", ")", ")", "{", "$", "vtimezoneObj", "=", "VObject", "\\", "Reader", "::", "read", "(", "$", "props", "[", "$", "ctz", "]", ")", ";", "$", "calendarTimeZone", "=", "$", "vtimezoneObj", "->", "VTIMEZONE", "->", "getTimeZone", "(", ")", ";", "// Destroy circular references so PHP can garbage collect the object.", "$", "vtimezoneObj", "->", "destroy", "(", ")", ";", "}", "// Getting the list of object uris within the time-range", "$", "urls", "=", "$", "node", "->", "calendarQuery", "(", "[", "'name'", "=>", "'VCALENDAR'", ",", "'comp-filters'", "=>", "[", "[", "'name'", "=>", "'VEVENT'", ",", "'comp-filters'", "=>", "[", "]", ",", "'prop-filters'", "=>", "[", "]", ",", "'is-not-defined'", "=>", "false", ",", "'time-range'", "=>", "[", "'start'", "=>", "$", "start", ",", "'end'", "=>", "$", "end", ",", "]", ",", "]", ",", "]", ",", "'prop-filters'", "=>", "[", "]", ",", "'is-not-defined'", "=>", "false", ",", "'time-range'", "=>", "null", ",", "]", ")", ";", "$", "calObjects", "=", "array_map", "(", "function", "(", "$", "url", ")", "use", "(", "$", "node", ")", "{", "$", "obj", "=", "$", "node", "->", "getChild", "(", "$", "url", ")", "->", "get", "(", ")", ";", "return", "$", "obj", ";", "}", ",", "$", "urls", ")", ";", "$", "objects", "=", "array_merge", "(", "$", "objects", ",", "$", "calObjects", ")", ";", "}", "$", "inboxProps", "=", "$", "this", "->", "server", "->", "getProperties", "(", "$", "inboxUrl", ",", "$", "caldavNS", ".", "'calendar-availability'", ")", ";", "$", "vcalendar", "=", "new", "VObject", "\\", "Component", "\\", "VCalendar", "(", ")", ";", "$", "vcalendar", "->", "METHOD", "=", "'REPLY'", ";", "$", "generator", "=", "new", "VObject", "\\", "FreeBusyGenerator", "(", ")", ";", "$", "generator", "->", "setObjects", "(", "$", "objects", ")", ";", "$", "generator", "->", "setTimeRange", "(", "$", "start", ",", "$", "end", ")", ";", "$", "generator", "->", "setBaseObject", "(", "$", "vcalendar", ")", ";", "$", "generator", "->", "setTimeZone", "(", "$", "calendarTimeZone", ")", ";", "if", "(", "$", "inboxProps", ")", "{", "$", "generator", "->", "setVAvailability", "(", "VObject", "\\", "Reader", "::", "read", "(", "$", "inboxProps", "[", "$", "caldavNS", ".", "'calendar-availability'", "]", ")", ")", ";", "}", "$", "result", "=", "$", "generator", "->", "getResult", "(", ")", ";", "$", "vcalendar", "->", "VFREEBUSY", "->", "ATTENDEE", "=", "'mailto:'", ".", "$", "email", ";", "$", "vcalendar", "->", "VFREEBUSY", "->", "UID", "=", "(", "string", ")", "$", "request", "->", "VFREEBUSY", "->", "UID", ";", "$", "vcalendar", "->", "VFREEBUSY", "->", "ORGANIZER", "=", "clone", "$", "request", "->", "VFREEBUSY", "->", "ORGANIZER", ";", "return", "[", "'calendar-data'", "=>", "$", "result", ",", "'request-status'", "=>", "'2.0;Success'", ",", "'href'", "=>", "'mailto:'", ".", "$", "email", ",", "]", ";", "}" ]

[ "Returns", "free", "-", "busy", "information", "for", "a", "specific", "address", ".", "The", "returned", "data", "is", "an", "array", "containing", "the", "following", "properties", ":", "." ]

[ "public", "function", "handle", "(", "$", "propertyName", ",", "$", "valueOrCallBack", ")", "{", "if", "(", "$", "this", "->", "itemsLeft", "&&", "isset", "(", "$", "this", "->", "result", "[", "$", "propertyName", "]", ")", "&&", "404", "===", "$", "this", "->", "result", "[", "$", "propertyName", "]", "[", "0", "]", ")", "{", "if", "(", "is_callable", "(", "$", "valueOrCallBack", ")", ")", "{", "$", "value", "=", "$", "valueOrCallBack", "(", ")", ";", "}", "else", "{", "$", "value", "=", "$", "valueOrCallBack", ";", "}", "if", "(", "!", "is_null", "(", "$", "value", ")", ")", "{", "--", "$", "this", "->", "itemsLeft", ";", "$", "this", "->", "result", "[", "$", "propertyName", "]", "=", "[", "200", ",", "$", "value", "]", ";", "}", "}", "}" ]

[ "Handles", "a", "specific", "property", "." ]

[ "public", "function", "set", "(", "$", "propertyName", ",", "$", "value", ",", "$", "status", "=", "null", ")", "{", "if", "(", "is_null", "(", "$", "status", ")", ")", "{", "$", "status", "=", "is_null", "(", "$", "value", ")", "?", "404", ":", "200", ";", "}", "// If this is an ALLPROPS request and the property is", "// unknown, add it to the result; else ignore it:", "if", "(", "!", "isset", "(", "$", "this", "->", "result", "[", "$", "propertyName", "]", ")", ")", "{", "if", "(", "self", "::", "ALLPROPS", "===", "$", "this", "->", "requestType", ")", "{", "$", "this", "->", "result", "[", "$", "propertyName", "]", "=", "[", "$", "status", ",", "$", "value", "]", ";", "}", "return", ";", "}", "if", "(", "404", "!==", "$", "status", "&&", "404", "===", "$", "this", "->", "result", "[", "$", "propertyName", "]", "[", "0", "]", ")", "{", "--", "$", "this", "->", "itemsLeft", ";", "}", "elseif", "(", "404", "===", "$", "status", "&&", "404", "!==", "$", "this", "->", "result", "[", "$", "propertyName", "]", "[", "0", "]", ")", "{", "++", "$", "this", "->", "itemsLeft", ";", "}", "$", "this", "->", "result", "[", "$", "propertyName", "]", "=", "[", "$", "status", ",", "$", "value", "]", ";", "}" ]

[ "Sets", "the", "value", "of", "the", "property", "." ]

[ "public", "function", "getStatus", "(", "$", "propertyName", ")", "{", "return", "isset", "(", "$", "this", "->", "result", "[", "$", "propertyName", "]", ")", "?", "$", "this", "->", "result", "[", "$", "propertyName", "]", "[", "0", "]", ":", "null", ";", "}" ]

[ "Returns", "the", "current", "status", "code", "for", "a", "property", "name", "." ]

[ "public", "function", "getResultForMultiStatus", "(", ")", "{", "$", "r", "=", "[", "200", "=>", "[", "]", ",", "404", "=>", "[", "]", ",", "]", ";", "foreach", "(", "$", "this", "->", "result", "as", "$", "propertyName", "=>", "$", "info", ")", "{", "if", "(", "!", "isset", "(", "$", "r", "[", "$", "info", "[", "0", "]", "]", ")", ")", "{", "$", "r", "[", "$", "info", "[", "0", "]", "]", "=", "[", "$", "propertyName", "=>", "$", "info", "[", "1", "]", "]", ";", "}", "else", "{", "$", "r", "[", "$", "info", "[", "0", "]", "]", "[", "$", "propertyName", "]", "=", "$", "info", "[", "1", "]", ";", "}", "}", "// Removing the 404's for multi-status requests.", "if", "(", "self", "::", "ALLPROPS", "===", "$", "this", "->", "requestType", ")", "{", "unset", "(", "$", "r", "[", "404", "]", ")", ";", "}", "return", "$", "r", ";", "}" ]

[ "Returns", "a", "result", "array", "that", "s", "often", "used", "in", "multistatus", "responses", "." ]

[ "public", "function", "getACL", "(", ")", "{", "return", "[", "[", "'privilege'", "=>", "'{'", ".", "CalDAV", "\\", "Plugin", "::", "NS_CALDAV", ".", "'}schedule-send'", ",", "'principal'", "=>", "$", "this", "->", "getOwner", "(", ")", ",", "'protected'", "=>", "true", ",", "]", ",", "[", "'privilege'", "=>", "'{DAV:}read'", ",", "'principal'", "=>", "$", "this", "->", "getOwner", "(", ")", ",", "'protected'", "=>", "true", ",", "]", ",", "[", "'privilege'", "=>", "'{'", ".", "CalDAV", "\\", "Plugin", "::", "NS_CALDAV", ".", "'}schedule-send'", ",", "'principal'", "=>", "$", "this", "->", "getOwner", "(", ")", ".", "'/calendar-proxy-write'", ",", "'protected'", "=>", "true", ",", "]", ",", "[", "'privilege'", "=>", "'{DAV:}read'", ",", "'principal'", "=>", "$", "this", "->", "getOwner", "(", ")", ".", "'/calendar-proxy-read'", ",", "'protected'", "=>", "true", ",", "]", ",", "[", "'privilege'", "=>", "'{DAV:}read'", ",", "'principal'", "=>", "$", "this", "->", "getOwner", "(", ")", ".", "'/calendar-proxy-write'", ",", "'protected'", "=>", "true", ",", "]", ",", "]", ";", "}" ]

[ "Returns", "a", "list", "of", "ACE", "s", "for", "this", "node", "." ]

[ "public", "function", "getHTTPMethods", "(", "$", "uri", ")", "{", "$", "tree", "=", "$", "this", "->", "server", "->", "tree", ";", "if", "(", "$", "tree", "->", "nodeExists", "(", "$", "uri", ")", ")", "{", "$", "node", "=", "$", "tree", "->", "getNodeForPath", "(", "$", "uri", ")", ";", "if", "(", "$", "node", "instanceof", "IPatchSupport", ")", "{", "return", "[", "'PATCH'", "]", ";", "}", "}", "return", "[", "]", ";", "}" ]

[ "Use", "this", "method", "to", "tell", "the", "server", "this", "plugin", "defines", "additional", "HTTP", "methods", "." ]

[ "public", "function", "httpPatch", "(", "RequestInterface", "$", "request", ",", "ResponseInterface", "$", "response", ")", "{", "$", "path", "=", "$", "request", "->", "getPath", "(", ")", ";", "// Get the node. Will throw a 404 if not found", "$", "node", "=", "$", "this", "->", "server", "->", "tree", "->", "getNodeForPath", "(", "$", "path", ")", ";", "if", "(", "!", "$", "node", "instanceof", "IPatchSupport", ")", "{", "throw", "new", "DAV", "\\", "Exception", "\\", "MethodNotAllowed", "(", "'The target resource does not support the PATCH method.'", ")", ";", "}", "$", "range", "=", "$", "this", "->", "getHTTPUpdateRange", "(", "$", "request", ")", ";", "if", "(", "!", "$", "range", ")", "{", "throw", "new", "DAV", "\\", "Exception", "\\", "BadRequest", "(", "'No valid \"X-Update-Range\" found in the headers'", ")", ";", "}", "$", "contentType", "=", "strtolower", "(", "(", "string", ")", "$", "request", "->", "getHeader", "(", "'Content-Type'", ")", ")", ";", "if", "(", "'application/x-sabredav-partialupdate'", "!=", "$", "contentType", ")", "{", "throw", "new", "DAV", "\\", "Exception", "\\", "UnsupportedMediaType", "(", "'Unknown Content-Type header \"'", ".", "$", "contentType", ".", "'\"'", ")", ";", "}", "$", "len", "=", "$", "this", "->", "server", "->", "httpRequest", "->", "getHeader", "(", "'Content-Length'", ")", ";", "if", "(", "!", "$", "len", ")", "{", "throw", "new", "DAV", "\\", "Exception", "\\", "LengthRequired", "(", "'A Content-Length header is required'", ")", ";", "}", "switch", "(", "$", "range", "[", "0", "]", ")", "{", "case", "self", "::", "RANGE_START", ":", "// Calculate the end-range if it doesn't exist.", "if", "(", "!", "$", "range", "[", "2", "]", ")", "{", "$", "range", "[", "2", "]", "=", "$", "range", "[", "1", "]", "+", "$", "len", "-", "1", ";", "}", "else", "{", "if", "(", "$", "range", "[", "2", "]", "<", "$", "range", "[", "1", "]", ")", "{", "throw", "new", "DAV", "\\", "Exception", "\\", "RequestedRangeNotSatisfiable", "(", "'The end offset ('", ".", "$", "range", "[", "2", "]", ".", "') is lower than the start offset ('", ".", "$", "range", "[", "1", "]", ".", "')'", ")", ";", "}", "if", "(", "$", "range", "[", "2", "]", "-", "$", "range", "[", "1", "]", "+", "1", "!=", "$", "len", ")", "{", "throw", "new", "DAV", "\\", "Exception", "\\", "RequestedRangeNotSatisfiable", "(", "'Actual data length ('", ".", "$", "len", ".", "') is not consistent with begin ('", ".", "$", "range", "[", "1", "]", ".", "') and end ('", ".", "$", "range", "[", "2", "]", ".", "') offsets'", ")", ";", "}", "}", "break", ";", "}", "if", "(", "!", "$", "this", "->", "server", "->", "emit", "(", "'beforeWriteContent'", ",", "[", "$", "path", ",", "$", "node", ",", "null", "]", ")", ")", "{", "return", ";", "}", "$", "body", "=", "$", "this", "->", "server", "->", "httpRequest", "->", "getBody", "(", ")", ";", "$", "etag", "=", "$", "node", "->", "patch", "(", "$", "body", ",", "$", "range", "[", "0", "]", ",", "isset", "(", "$", "range", "[", "1", "]", ")", "?", "$", "range", "[", "1", "]", ":", "null", ")", ";", "$", "this", "->", "server", "->", "emit", "(", "'afterWriteContent'", ",", "[", "$", "path", ",", "$", "node", "]", ")", ";", "$", "response", "->", "setHeader", "(", "'Content-Length'", ",", "'0'", ")", ";", "if", "(", "$", "etag", ")", "{", "$", "response", "->", "setHeader", "(", "'ETag'", ",", "$", "etag", ")", ";", "}", "$", "response", "->", "setStatus", "(", "204", ")", ";", "// Breaks the event chain", "return", "false", ";", "}" ]

[ "Patch", "an", "uri", "." ]

[ "public", "function", "getHTTPUpdateRange", "(", "RequestInterface", "$", "request", ")", "{", "$", "range", "=", "$", "request", "->", "getHeader", "(", "'X-Update-Range'", ")", ";", "if", "(", "is_null", "(", "$", "range", ")", ")", "{", "return", "null", ";", "}", "// Matching \"Range: bytes=1234-5678: both numbers are optional", "if", "(", "!", "preg_match", "(", "'/^(append)|(?:bytes=([0-9]+)-([0-9]*))|(?:bytes=(-[0-9]+))$/i'", ",", "$", "range", ",", "$", "matches", ")", ")", "{", "return", "null", ";", "}", "if", "(", "'append'", "===", "$", "matches", "[", "1", "]", ")", "{", "return", "[", "self", "::", "RANGE_APPEND", "]", ";", "}", "elseif", "(", "strlen", "(", "$", "matches", "[", "2", "]", ")", ">", "0", ")", "{", "return", "[", "self", "::", "RANGE_START", ",", "(", "int", ")", "$", "matches", "[", "2", "]", ",", "(", "int", ")", "$", "matches", "[", "3", "]", "?", ":", "null", "]", ";", "}", "else", "{", "return", "[", "self", "::", "RANGE_END", ",", "(", "int", ")", "$", "matches", "[", "4", "]", "]", ";", "}", "}" ]

[ "Returns", "the", "HTTP", "custom", "range", "update", "header", "." ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "TypeResolver", "$", "typeResolver", "=", "null", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "?", "self", "{", "Assert", "::", "stringNotEmpty", "(", "$", "body", ")", ";", "Assert", "::", "allNotNull", "(", "[", "$", "typeResolver", ",", "$", "descriptionFactory", "]", ")", ";", "// 1. none or more whitespace", "// 2. optionally the keyword \"static\" followed by whitespace", "// 3. optionally a word with underscores followed by whitespace : as", "// type for the return value", "// 4. then optionally a word with underscores followed by () and", "// whitespace : as method name as used by phpDocumentor", "// 5. then a word with underscores, followed by ( and any character", "// until a ) and whitespace : as method name with signature", "// 6. any remaining text : as description", "if", "(", "!", "preg_match", "(", "'/^\n # Static keyword\n # Declares a static method ONLY if type is also present\n (?:\n (static)\n \\s+\n )?\n # Return type\n (?:\n (\n (?:[\\w\\|_\\\\\\\\]*\\$this[\\w\\|_\\\\\\\\]*)\n |\n (?:\n (?:[\\w\\|_\\\\\\\\]+)\n # array notation\n (?:\\[\\])*\n )*\n )\n \\s+\n )?\n # Legacy method name (not captured)\n (?:\n [\\w_]+\\(\\)\\s+\n )?\n # Method name\n ([\\w\\|_\\\\\\\\]+)\n # Arguments\n (?:\n \\(([^\\)]*)\\)\n )?\n \\s*\n # Description\n (.*)\n $/sux'", ",", "$", "body", ",", "$", "matches", ")", ")", "{", "return", "null", ";", "}", "[", ",", "$", "static", ",", "$", "returnType", ",", "$", "methodName", ",", "$", "arguments", ",", "$", "description", "]", "=", "$", "matches", ";", "$", "static", "=", "$", "static", "===", "'static'", ";", "if", "(", "$", "returnType", "===", "''", ")", "{", "$", "returnType", "=", "'void'", ";", "}", "$", "returnType", "=", "$", "typeResolver", "->", "resolve", "(", "$", "returnType", ",", "$", "context", ")", ";", "$", "description", "=", "$", "descriptionFactory", "->", "create", "(", "$", "description", ",", "$", "context", ")", ";", "if", "(", "is_string", "(", "$", "arguments", ")", "&&", "strlen", "(", "$", "arguments", ")", ">", "0", ")", "{", "$", "arguments", "=", "explode", "(", "','", ",", "$", "arguments", ")", ";", "foreach", "(", "$", "arguments", "as", "&", "$", "argument", ")", "{", "$", "argument", "=", "explode", "(", "' '", ",", "self", "::", "stripRestArg", "(", "trim", "(", "$", "argument", ")", ")", ",", "2", ")", ";", "if", "(", "$", "argument", "[", "0", "]", "[", "0", "]", "===", "'$'", ")", "{", "$", "argumentName", "=", "substr", "(", "$", "argument", "[", "0", "]", ",", "1", ")", ";", "$", "argumentType", "=", "new", "Void_", "(", ")", ";", "}", "else", "{", "$", "argumentType", "=", "$", "typeResolver", "->", "resolve", "(", "$", "argument", "[", "0", "]", ",", "$", "context", ")", ";", "$", "argumentName", "=", "''", ";", "if", "(", "isset", "(", "$", "argument", "[", "1", "]", ")", ")", "{", "$", "argument", "[", "1", "]", "=", "self", "::", "stripRestArg", "(", "$", "argument", "[", "1", "]", ")", ";", "$", "argumentName", "=", "substr", "(", "$", "argument", "[", "1", "]", ",", "1", ")", ";", "}", "}", "$", "argument", "=", "[", "'name'", "=>", "$", "argumentName", ",", "'type'", "=>", "$", "argumentType", "]", ";", "}", "}", "else", "{", "$", "arguments", "=", "[", "]", ";", "}", "return", "new", "static", "(", "$", "methodName", ",", "$", "arguments", ",", "$", "returnType", ",", "$", "static", ",", "$", "description", ")", ";", "}" ]

[ "{" ]

[ "public", "function", "render", "(", "?", "Formatter", "$", "formatter", "=", "null", ")", ":", "string", "{", "if", "(", "$", "formatter", "===", "null", ")", "{", "$", "formatter", "=", "new", "PassthroughFormatter", "(", ")", ";", "}", "$", "tags", "=", "[", "]", ";", "foreach", "(", "$", "this", "->", "tags", "as", "$", "tag", ")", "{", "$", "tags", "[", "]", "=", "'{'", ".", "$", "formatter", "->", "format", "(", "$", "tag", ")", ".", "'}'", ";", "}", "return", "vsprintf", "(", "$", "this", "->", "bodyTemplate", ",", "$", "tags", ")", ";", "}" ]

[ "Renders", "this", "description", "as", "a", "string", "where", "the", "provided", "formatter", "will", "format", "the", "tags", "in", "the", "expected", "string", "format", "." ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "Context", "$", "context", "=", "null", ")", ":", "MyTag", "{", "Assert", "::", "notNull", "(", "$", "descriptionFactory", ")", ";", "return", "new", "static", "(", "$", "descriptionFactory", "->", "create", "(", "$", "body", ",", "$", "context", ")", ")", ";", "}" ]

[ "A", "static", "Factory", "that", "creates", "a", "new", "instance", "of", "the", "current", "Tag", "." ]

[ "public", "function", "getTagsByName", "(", "string", "$", "name", ")", ":", "array", "{", "$", "result", "=", "[", "]", ";", "/** @var Tag $tag */", "foreach", "(", "$", "this", "->", "getTags", "(", ")", "as", "$", "tag", ")", "{", "if", "(", "$", "tag", "->", "getName", "(", ")", "!==", "$", "name", ")", "{", "continue", ";", "}", "$", "result", "[", "]", "=", "$", "tag", ";", "}", "return", "$", "result", ";", "}" ]

[ "Returns", "an", "array", "of", "tags", "matching", "the", "given", "name", ".", "If", "no", "tags", "are", "found", "an", "empty", "array", "is", "returned", "." ]

[ "public", "function", "hasTag", "(", "string", "$", "name", ")", ":", "bool", "{", "/** @var Tag $tag */", "foreach", "(", "$", "this", "->", "getTags", "(", ")", "as", "$", "tag", ")", "{", "if", "(", "$", "tag", "->", "getName", "(", ")", "===", "$", "name", ")", "{", "return", "true", ";", "}", "}", "return", "false", ";", "}" ]

[ "Checks", "if", "a", "tag", "of", "a", "certain", "type", "is", "present", "in", "this", "DocBlock", "." ]

[ "public", "function", "removeTag", "(", "Tag", "$", "tagToRemove", ")", ":", "void", "{", "foreach", "(", "$", "this", "->", "tags", "as", "$", "key", "=>", "$", "tag", ")", "{", "if", "(", "$", "tag", "===", "$", "tagToRemove", ")", "{", "unset", "(", "$", "this", "->", "tags", "[", "$", "key", "]", ")", ";", "break", ";", "}", "}", "}" ]

[ "Remove", "a", "tag", "from", "this", "DocBlock", "." ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "string", "$", "name", "=", "''", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "stringNotEmpty", "(", "$", "name", ")", ";", "Assert", "::", "notNull", "(", "$", "descriptionFactory", ")", ";", "$", "description", "=", "$", "descriptionFactory", "&&", "$", "body", "!==", "\"\"", "?", "$", "descriptionFactory", "->", "create", "(", "$", "body", ",", "$", "context", ")", ":", "null", ";", "return", "new", "static", "(", "$", "name", ",", "$", "description", ")", ";", "}" ]

[ "Creates", "a", "new", "tag", "that", "represents", "any", "unknown", "tag", "type", "." ]

[ "private", "function", "validateTagName", "(", "string", "$", "name", ")", ":", "void", "{", "if", "(", "!", "preg_match", "(", "'/^'", ".", "StandardTagFactory", "::", "REGEX_TAGNAME", ".", "'$/u'", ",", "$", "name", ")", ")", "{", "throw", "new", "\\", "InvalidArgumentException", "(", "'The tag name \"'", ".", "$", "name", ".", "'\" is not wellformed. Tags may only consist of letters, underscores, '", ".", "'hyphens and backslashes.'", ")", ";", "}", "}" ]

[ "Validates", "if", "the", "tag", "name", "matches", "the", "expected", "format", "otherwise", "throws", "an", "exception", "." ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "TypeResolver", "$", "typeResolver", "=", "null", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "stringNotEmpty", "(", "$", "body", ")", ";", "Assert", "::", "allNotNull", "(", "[", "$", "typeResolver", ",", "$", "descriptionFactory", "]", ")", ";", "$", "parts", "=", "preg_split", "(", "'/(\\s+)/Su'", ",", "$", "body", ",", "3", ",", "PREG_SPLIT_DELIM_CAPTURE", ")", ";", "$", "type", "=", "null", ";", "$", "variableName", "=", "''", ";", "// if the first item that is encountered is not a variable; it is a type", "if", "(", "isset", "(", "$", "parts", "[", "0", "]", ")", "&&", "(", "strlen", "(", "$", "parts", "[", "0", "]", ")", ">", "0", ")", "&&", "(", "$", "parts", "[", "0", "]", "[", "0", "]", "!==", "'$'", ")", ")", "{", "$", "type", "=", "$", "typeResolver", "->", "resolve", "(", "array_shift", "(", "$", "parts", ")", ",", "$", "context", ")", ";", "array_shift", "(", "$", "parts", ")", ";", "}", "// if the next item starts with a $ or ...$ it must be the variable name", "if", "(", "isset", "(", "$", "parts", "[", "0", "]", ")", "&&", "(", "strlen", "(", "$", "parts", "[", "0", "]", ")", ">", "0", ")", "&&", "(", "$", "parts", "[", "0", "]", "[", "0", "]", "===", "'$'", ")", ")", "{", "$", "variableName", "=", "array_shift", "(", "$", "parts", ")", ";", "array_shift", "(", "$", "parts", ")", ";", "if", "(", "substr", "(", "$", "variableName", ",", "0", ",", "1", ")", "===", "'$'", ")", "{", "$", "variableName", "=", "substr", "(", "$", "variableName", ",", "1", ")", ";", "}", "}", "$", "description", "=", "$", "descriptionFactory", "->", "create", "(", "implode", "(", "''", ",", "$", "parts", ")", ",", "$", "context", ")", ";", "return", "new", "static", "(", "$", "variableName", ",", "$", "type", ",", "$", "description", ")", ";", "}" ]

[ "{" ]

[ "public", "function", "create", "(", "string", "$", "contents", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "Description", "{", "[", "$", "text", ",", "$", "tags", "]", "=", "$", "this", "->", "parse", "(", "$", "this", "->", "lex", "(", "$", "contents", ")", ",", "$", "context", ")", ";", "return", "new", "Description", "(", "$", "text", ",", "$", "tags", ")", ";", "}" ]

[ "Returns", "the", "parsed", "text", "of", "this", "description", "." ]

[ "private", "function", "lex", "(", "string", "$", "contents", ")", ":", "array", "{", "$", "contents", "=", "$", "this", "->", "removeSuperfluousStartingWhitespace", "(", "$", "contents", ")", ";", "// performance optimalization; if there is no inline tag, don't bother splitting it up.", "if", "(", "strpos", "(", "$", "contents", ",", "'{@'", ")", "===", "false", ")", "{", "return", "[", "$", "contents", "]", ";", "}", "return", "preg_split", "(", "'/\\{\n # \"{@}\" is not a valid inline tag. This ensures that we do not treat it as one, but treat it literally.\n (?!@\\})\n # We want to capture the whole tag line, but without the inline tag delimiters.\n (\\@\n # Match everything up to the next delimiter.\n [^{}]*\n # Nested inline tag content should not be captured, or it will appear in the result separately.\n (?:\n # Match nested inline tags.\n (?:\n # Because we did not catch the tag delimiters earlier, we must be explicit with them here.\n # Notice that this also matches \"{}\", as a way to later introduce it as an escape sequence.\n \\{(?1)?\\}\n |\n # Make sure we match hanging \"{\".\n \\{\n )\n # Match content after the nested inline tag.\n [^{}]*\n )* # If there are more inline tags, match them as well. We use \"*\" since there may not be any\n # nested inline tags.\n )\n \\}/Sux'", ",", "$", "contents", ",", "0", ",", "PREG_SPLIT_DELIM_CAPTURE", ")", ";", "}" ]

[ "Strips", "the", "contents", "from", "superfluous", "whitespace", "and", "splits", "the", "description", "into", "a", "series", "of", "tokens", "." ]

[ "private", "function", "parse", "(", "$", "tokens", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "array", "{", "$", "count", "=", "count", "(", "$", "tokens", ")", ";", "$", "tagCount", "=", "0", ";", "$", "tags", "=", "[", "]", ";", "for", "(", "$", "i", "=", "1", ";", "$", "i", "<", "$", "count", ";", "$", "i", "+=", "2", ")", "{", "$", "tags", "[", "]", "=", "$", "this", "->", "tagFactory", "->", "create", "(", "$", "tokens", "[", "$", "i", "]", ",", "$", "context", ")", ";", "$", "tokens", "[", "$", "i", "]", "=", "'%'", ".", "++", "$", "tagCount", ".", "'$s'", ";", "}", "//In order to allow \"literal\" inline tags, the otherwise invalid", "//sequence \"{@}\" is changed to \"@\", and \"{}\" is changed to \"}\".", "//\"%\" is escaped to \"%%\" because of vsprintf.", "//See unit tests for examples.", "for", "(", "$", "i", "=", "0", ";", "$", "i", "<", "$", "count", ";", "$", "i", "+=", "2", ")", "{", "$", "tokens", "[", "$", "i", "]", "=", "str_replace", "(", "[", "'{@}'", ",", "'{}'", ",", "'%'", "]", ",", "[", "'@'", ",", "'}'", ",", "'%%'", "]", ",", "$", "tokens", "[", "$", "i", "]", ")", ";", "}", "return", "[", "implode", "(", "''", ",", "$", "tokens", ")", ",", "$", "tags", "]", ";", "}" ]

[ "Parses", "the", "stream", "of", "tokens", "in", "to", "a", "new", "set", "of", "tokens", "containing", "Tags", "." ]

[ "private", "function", "removeSuperfluousStartingWhitespace", "(", "string", "$", "contents", ")", ":", "string", "{", "$", "lines", "=", "explode", "(", "\"\\n\"", ",", "$", "contents", ")", ";", "// if there is only one line then we don't have lines with superfluous whitespace and", "// can use the contents as-is", "if", "(", "count", "(", "$", "lines", ")", "<=", "1", ")", "{", "return", "$", "contents", ";", "}", "// determine how many whitespace characters need to be stripped", "$", "startingSpaceCount", "=", "9999999", ";", "for", "(", "$", "i", "=", "1", ";", "$", "i", "<", "count", "(", "$", "lines", ")", ";", "++", "$", "i", ")", "{", "// lines with a no length do not count as they are not indented at all", "if", "(", "strlen", "(", "trim", "(", "$", "lines", "[", "$", "i", "]", ")", ")", "===", "0", ")", "{", "continue", ";", "}", "// determine the number of prefixing spaces by checking the difference in line length before and after", "// an ltrim", "$", "startingSpaceCount", "=", "min", "(", "$", "startingSpaceCount", ",", "strlen", "(", "$", "lines", "[", "$", "i", "]", ")", "-", "strlen", "(", "ltrim", "(", "$", "lines", "[", "$", "i", "]", ")", ")", ")", ";", "}", "// strip the number of spaces from each line", "if", "(", "$", "startingSpaceCount", ">", "0", ")", "{", "for", "(", "$", "i", "=", "1", ";", "$", "i", "<", "count", "(", "$", "lines", ")", ";", "++", "$", "i", ")", "{", "$", "lines", "[", "$", "i", "]", "=", "substr", "(", "$", "lines", "[", "$", "i", "]", ",", "$", "startingSpaceCount", ")", ";", "}", "}", "return", "implode", "(", "\"\\n\"", ",", "$", "lines", ")", ";", "}" ]

[ "Removes", "the", "superfluous", "from", "a", "multi", "-", "line", "description", "." ]

[ "public", "function", "getDocComment", "(", "DocBlock", "$", "docblock", ")", ":", "string", "{", "$", "indent", "=", "str_repeat", "(", "$", "this", "->", "indentString", ",", "$", "this", "->", "indent", ")", ";", "$", "firstIndent", "=", "$", "this", "->", "isFirstLineIndented", "?", "$", "indent", ":", "''", ";", "// 3 === strlen(' * ')", "$", "wrapLength", "=", "$", "this", "->", "lineLength", "?", "$", "this", "->", "lineLength", "-", "strlen", "(", "$", "indent", ")", "-", "3", ":", "null", ";", "$", "text", "=", "$", "this", "->", "removeTrailingSpaces", "(", "$", "indent", ",", "$", "this", "->", "addAsterisksForEachLine", "(", "$", "indent", ",", "$", "this", "->", "getSummaryAndDescriptionTextBlock", "(", "$", "docblock", ",", "$", "wrapLength", ")", ")", ")", ";", "$", "comment", "=", "\"{$firstIndent}/**\\n\"", ";", "if", "(", "$", "text", ")", "{", "$", "comment", ".=", "\"{$indent} * {$text}\\n\"", ";", "$", "comment", ".=", "\"{$indent} *\\n\"", ";", "}", "$", "comment", "=", "$", "this", "->", "addTagBlock", "(", "$", "docblock", ",", "$", "wrapLength", ",", "$", "indent", ",", "$", "comment", ")", ";", "$", "comment", ".=", "$", "indent", ".", "' */'", ";", "return", "$", "comment", ";", "}" ]

[ "Generate", "a", "DocBlock", "comment", "." ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "stringNotEmpty", "(", "$", "body", ")", ";", "Assert", "::", "notNull", "(", "$", "descriptionFactory", ")", ";", "$", "startingLine", "=", "1", ";", "$", "lineCount", "=", "null", ";", "$", "description", "=", "null", ";", "// Starting line / Number of lines / Description", "if", "(", "preg_match", "(", "'/^([1-9]\\d*)\\s*(?:((?1))\\s+)?(.*)$/sux'", ",", "$", "body", ",", "$", "matches", ")", ")", "{", "$", "startingLine", "=", "(", "int", ")", "$", "matches", "[", "1", "]", ";", "if", "(", "isset", "(", "$", "matches", "[", "2", "]", ")", "&&", "$", "matches", "[", "2", "]", "!==", "''", ")", "{", "$", "lineCount", "=", "(", "int", ")", "$", "matches", "[", "2", "]", ";", "}", "$", "description", "=", "$", "matches", "[", "3", "]", ";", "}", "return", "new", "static", "(", "$", "startingLine", ",", "$", "lineCount", ",", "$", "descriptionFactory", "->", "create", "(", "$", "description", ",", "$", "context", ")", ")", ";", "}" ]

[ "{" ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "FqsenResolver", "$", "resolver", "=", "null", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "allNotNull", "(", "[", "$", "resolver", ",", "$", "descriptionFactory", "]", ")", ";", "$", "parts", "=", "preg_split", "(", "'/\\s+/Su'", ",", "$", "body", ",", "2", ")", ";", "$", "description", "=", "isset", "(", "$", "parts", "[", "1", "]", ")", "?", "$", "descriptionFactory", "->", "create", "(", "$", "parts", "[", "1", "]", ",", "$", "context", ")", ":", "null", ";", "// https://tools.ietf.org/html/rfc2396#section-3", "if", "(", "preg_match", "(", "'/\\w:\\/\\/\\w/i'", ",", "$", "parts", "[", "0", "]", ")", ")", "{", "return", "new", "static", "(", "new", "Url", "(", "$", "parts", "[", "0", "]", ")", ",", "$", "description", ")", ";", "}", "return", "new", "static", "(", "new", "FqsenRef", "(", "$", "resolver", "->", "resolve", "(", "$", "parts", "[", "0", "]", ",", "$", "context", ")", ")", ",", "$", "description", ")", ";", "}" ]

[ "{" ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "notNull", "(", "$", "descriptionFactory", ")", ";", "$", "parts", "=", "preg_split", "(", "'/\\s+/Su'", ",", "$", "body", ",", "2", ")", ";", "$", "description", "=", "isset", "(", "$", "parts", "[", "1", "]", ")", "?", "$", "descriptionFactory", "->", "create", "(", "$", "parts", "[", "1", "]", ",", "$", "context", ")", ":", "null", ";", "return", "new", "static", "(", "$", "parts", "[", "0", "]", ",", "$", "description", ")", ";", "}" ]

[ "{" ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "TypeResolver", "$", "typeResolver", "=", "null", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "allNotNull", "(", "[", "$", "typeResolver", ",", "$", "descriptionFactory", "]", ")", ";", "$", "parts", "=", "preg_split", "(", "'/\\s+/Su'", ",", "$", "body", ",", "2", ")", ";", "$", "type", "=", "$", "typeResolver", "->", "resolve", "(", "$", "parts", "[", "0", "]", "??", "''", ",", "$", "context", ")", ";", "$", "description", "=", "$", "descriptionFactory", "->", "create", "(", "$", "parts", "[", "1", "]", "??", "''", ",", "$", "context", ")", ";", "return", "new", "static", "(", "$", "type", ",", "$", "description", ")", ";", "}" ]

[ "{" ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ",", "?", "DescriptionFactory", "$", "descriptionFactory", "=", "null", ",", "?", "FqsenResolver", "$", "resolver", "=", "null", ",", "?", "TypeContext", "$", "context", "=", "null", ")", ":", "self", "{", "Assert", "::", "notEmpty", "(", "$", "body", ")", ";", "$", "parts", "=", "preg_split", "(", "'/\\s+/Su'", ",", "$", "body", ",", "2", ")", ";", "return", "new", "static", "(", "$", "resolver", "->", "resolve", "(", "$", "parts", "[", "0", "]", ",", "$", "context", ")", ",", "$", "descriptionFactory", "->", "create", "(", "$", "parts", "[", "1", "]", "??", "''", ",", "$", "context", ")", ")", ";", "}" ]

[ "{" ]

[ "public", "function", "find", "(", "Example", "$", "example", ")", ":", "string", "{", "$", "filename", "=", "$", "example", "->", "getFilePath", "(", ")", ";", "$", "file", "=", "$", "this", "->", "getExampleFileContents", "(", "$", "filename", ")", ";", "if", "(", "!", "$", "file", ")", "{", "return", "\"** File not found : {$filename} **\"", ";", "}", "return", "implode", "(", "''", ",", "array_slice", "(", "$", "file", ",", "$", "example", "->", "getStartingLine", "(", ")", "-", "1", ",", "$", "example", "->", "getLineCount", "(", ")", ")", ")", ";", "}" ]

[ "Attempts", "to", "find", "the", "example", "contents", "for", "the", "given", "descriptor", "." ]

[ "public", "static", "function", "createInstance", "(", "array", "$", "additionalTags", "=", "[", "]", ")", ":", "self", "{", "$", "fqsenResolver", "=", "new", "FqsenResolver", "(", ")", ";", "$", "tagFactory", "=", "new", "StandardTagFactory", "(", "$", "fqsenResolver", ")", ";", "$", "descriptionFactory", "=", "new", "DescriptionFactory", "(", "$", "tagFactory", ")", ";", "$", "tagFactory", "->", "addService", "(", "$", "descriptionFactory", ")", ";", "$", "tagFactory", "->", "addService", "(", "new", "TypeResolver", "(", "$", "fqsenResolver", ")", ")", ";", "$", "docBlockFactory", "=", "new", "self", "(", "$", "descriptionFactory", ",", "$", "tagFactory", ")", ";", "foreach", "(", "$", "additionalTags", "as", "$", "tagName", "=>", "$", "tagHandler", ")", "{", "$", "docBlockFactory", "->", "registerTagHandler", "(", "$", "tagName", ",", "$", "tagHandler", ")", ";", "}", "return", "$", "docBlockFactory", ";", "}" ]

[ "Factory", "method", "for", "easy", "instantiation", "." ]

[ "private", "function", "stripDocComment", "(", "string", "$", "comment", ")", ":", "string", "{", "$", "comment", "=", "trim", "(", "preg_replace", "(", "'#[ \\t]*(?:\\/\\*\\*|\\*\\/|\\*)?[ \\t]{0,1}(.*)?#u'", ",", "'$1'", ",", "$", "comment", ")", ")", ";", "// reg ex above is not able to remove */ from a single line docblock", "if", "(", "substr", "(", "$", "comment", ",", "-", "2", ")", "===", "'*/'", ")", "{", "$", "comment", "=", "trim", "(", "substr", "(", "$", "comment", ",", "0", ",", "-", "2", ")", ")", ";", "}", "return", "str_replace", "(", "[", "\"\\r\\n\"", ",", "\"\\r\"", "]", ",", "\"\\n\"", ",", "$", "comment", ")", ";", "}" ]

[ "Strips", "the", "asterisks", "from", "the", "DocBlock", "comment", "." ]

[ "private", "function", "splitDocBlock", "(", "string", "$", "comment", ")", ":", "array", "{", "// Performance improvement cheat: if the first character is an @ then only tags are in this DocBlock. This", "// method does not split tags so we return this verbatim as the fourth result (tags). This saves us the", "// performance impact of running a regular expression", "if", "(", "strpos", "(", "$", "comment", ",", "'@'", ")", "===", "0", ")", "{", "return", "[", "''", ",", "''", ",", "''", ",", "$", "comment", "]", ";", "}", "// clears all extra horizontal whitespace from the line endings to prevent parsing issues", "$", "comment", "=", "preg_replace", "(", "'/\\h*$/Sum'", ",", "''", ",", "$", "comment", ")", ";", "/*\n * Splits the docblock into a template marker, summary, description and tags section.\n *\n * - The template marker is empty, #@+ or #@- if the DocBlock starts with either of those (a newline may\n * occur after it and will be stripped).\n * - The short description is started from the first character until a dot is encountered followed by a\n * newline OR two consecutive newlines (horizontal whitespace is taken into account to consider spacing\n * errors). This is optional.\n * - The long description, any character until a new line is encountered followed by an @ and word\n * characters (a tag). This is optional.\n * - Tags; the remaining characters\n *\n * Big thanks to RichardJ for contributing this Regular Expression\n */", "preg_match", "(", "'/\n \\A\n # 1. Extract the template marker\n (?:(\\#\\@\\+|\\#\\@\\-)\\n?)?\n\n # 2. Extract the summary\n (?:\n (?! @\\pL ) # The summary may not start with an @\n (\n [^\\n.]+\n (?:\n (?! \\. \\n | \\n{2} ) # End summary upon a dot followed by newline or two newlines\n [\\n.]* (?! [ \\t]* @\\pL ) # End summary when an @ is found as first character on a new line\n [^\\n.]+ # Include anything else\n )*\n \\.?\n )?\n )\n\n # 3. Extract the description\n (?:\n \\s* # Some form of whitespace _must_ precede a description because a summary must be there\n (?! @\\pL ) # The description may not start with an @\n (\n [^\\n]+\n (?: \\n+\n (?! [ \\t]* @\\pL ) # End description when an @ is found as first character on a new line\n [^\\n]+ # Include anything else\n )*\n )\n )?\n\n # 4. Extract the tags (anything that follows)\n (\\s+ [\\s\\S]*)? # everything that follows\n /ux'", ",", "$", "comment", ",", "$", "matches", ")", ";", "array_shift", "(", "$", "matches", ")", ";", "while", "(", "count", "(", "$", "matches", ")", "<", "4", ")", "{", "$", "matches", "[", "]", "=", "''", ";", "}", "return", "$", "matches", ";", "}" ]

[ "Splits", "the", "DocBlock", "into", "a", "template", "marker", "summary", "description", "and", "block", "of", "tags", "." ]

[ "private", "function", "parseTagBlock", "(", "string", "$", "tags", ",", "Types", "\\", "Context", "$", "context", ")", ":", "array", "{", "$", "tags", "=", "$", "this", "->", "filterTagBlock", "(", "$", "tags", ")", ";", "if", "(", "!", "$", "tags", ")", "{", "return", "[", "]", ";", "}", "$", "result", "=", "$", "this", "->", "splitTagBlockIntoTagLines", "(", "$", "tags", ")", ";", "foreach", "(", "$", "result", "as", "$", "key", "=>", "$", "tagLine", ")", "{", "$", "result", "[", "$", "key", "]", "=", "$", "this", "->", "tagFactory", "->", "create", "(", "trim", "(", "$", "tagLine", ")", ",", "$", "context", ")", ";", "}", "return", "$", "result", ";", "}" ]

[ "Creates", "the", "tag", "objects", "." ]

[ "public", "function", "getContent", "(", ")", "{", "if", "(", "null", "===", "$", "this", "->", "description", ")", "{", "$", "filePath", "=", "'\"'", ".", "$", "this", "->", "filePath", ".", "'\"'", ";", "if", "(", "$", "this", "->", "isURI", ")", "{", "$", "filePath", "=", "$", "this", "->", "isUriRelative", "(", "$", "this", "->", "filePath", ")", "?", "str_replace", "(", "'%2F'", ",", "'/'", ",", "rawurlencode", "(", "$", "this", "->", "filePath", ")", ")", ":", "$", "this", "->", "filePath", ";", "}", "return", "trim", "(", "$", "filePath", ".", "' '", ".", "parent", "::", "getDescription", "(", ")", ")", ";", "}", "return", "$", "this", "->", "description", ";", "}" ]

[ "{" ]

[ "public", "static", "function", "create", "(", "string", "$", "body", ")", ":", "?", "Tag", "{", "// File component: File path in quotes or File URI / Source information", "if", "(", "!", "preg_match", "(", "'/^(?:\\\"([^\\\"]+)\\\"|(\\S+))(?:\\s+(.*))?$/sux'", ",", "$", "body", ",", "$", "matches", ")", ")", "{", "return", "null", ";", "}", "$", "filePath", "=", "null", ";", "$", "fileUri", "=", "null", ";", "if", "(", "''", "!==", "$", "matches", "[", "1", "]", ")", "{", "$", "filePath", "=", "$", "matches", "[", "1", "]", ";", "}", "else", "{", "$", "fileUri", "=", "$", "matches", "[", "2", "]", ";", "}", "$", "startingLine", "=", "1", ";", "$", "lineCount", "=", "0", ";", "$", "description", "=", "null", ";", "if", "(", "array_key_exists", "(", "3", ",", "$", "matches", ")", ")", "{", "$", "description", "=", "$", "matches", "[", "3", "]", ";", "// Starting line / Number of lines / Description", "if", "(", "preg_match", "(", "'/^([1-9]\\d*)(?:\\s+((?1))\\s*)?(.*)$/sux'", ",", "$", "matches", "[", "3", "]", ",", "$", "contentMatches", ")", ")", "{", "$", "startingLine", "=", "(", "int", ")", "$", "contentMatches", "[", "1", "]", ";", "if", "(", "isset", "(", "$", "contentMatches", "[", "2", "]", ")", "&&", "$", "contentMatches", "[", "2", "]", "!==", "''", ")", "{", "$", "lineCount", "=", "(", "int", ")", "$", "contentMatches", "[", "2", "]", ";", "}", "if", "(", "array_key_exists", "(", "3", ",", "$", "contentMatches", ")", ")", "{", "$", "description", "=", "$", "contentMatches", "[", "3", "]", ";", "}", "}", "}", "return", "new", "static", "(", "$", "filePath", "!==", "null", "?", "$", "filePath", ":", "$", "fileUri", ",", "$", "fileUri", "!==", "null", ",", "$", "startingLine", ",", "$", "lineCount", ",", "$", "description", ")", ";", "}" ]

[ "{" ]

[ "public", "function", "format", "(", "Tag", "$", "tag", ")", ":", "string", "{", "return", "'@'", ".", "$", "tag", "->", "getName", "(", ")", ".", "str_repeat", "(", "' '", ",", "$", "this", "->", "maxLen", "-", "strlen", "(", "$", "tag", "->", "getName", "(", ")", ")", "+", "1", ")", ".", "(", "string", ")", "$", "tag", ";", "}" ]

[ "Formats", "the", "given", "tag", "to", "return", "a", "simple", "plain", "text", "version", "." ]