idnits 2.17.1 draft-reschke-webdav-search-06.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The abstract seems to contain references ([2], [1]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 1008 has weird spacing: '...ment is is an...' == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords -- however, there's a paragraph with a matching beginning. Boilerplate error? (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'SHOULD not' in this paragraph: Query grammars are identified by URIs. Applications SHOULD not attempt to retrieve these URIs even if they appear to be retrievable (for example, those that begin with "http://") -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (February 6, 2004) is 7378 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'XMLNS' is defined on line 1778, but no explicit reference was found in the text ** Obsolete normative reference: RFC 2518 (Obsoleted by RFC 4918) ** Obsolete normative reference: RFC 2616 (Obsoleted by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235) ** Obsolete normative reference: RFC 3023 (Obsoleted by RFC 7303) -- Possible downref: Non-RFC (?) normative reference: ref. 'XML' -- Possible downref: Non-RFC (?) normative reference: ref. 'XMLNS' -- Possible downref: Non-RFC (?) normative reference: ref. 'XPATH' -- Possible downref: Non-RFC (?) normative reference: ref. 'XS1' -- Possible downref: Non-RFC (?) normative reference: ref. 'XS2' == Outdated reference: A later version (-27) exists of draft-ietf-webdav-bind-03 -- No information found for draft-dasl-protocol - is the name correct? -- No information found for draft-dasl-requirements - is the name correct? Summary: 5 errors (**), 0 flaws (~~), 8 warnings (==), 9 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group J. Reschke, Ed. 3 Internet-Draft greenbytes 4 Expires: August 6, 2004 S. Reddy 5 Oracle 6 J. Davis 7 Intelligent Markets 8 A. Babich 9 Filenet 10 February 6, 2004 12 WebDAV SEARCH 13 draft-reschke-webdav-search-06 15 Status of this Memo 17 This document is an Internet-Draft and is in full conformance with 18 all provisions of Section 10 of RFC2026. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF), its areas, and its working groups. Note that other 22 groups may also distribute working documents as Internet-Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six months 25 and may be updated, replaced, or obsoleted by other documents at any 26 time. It is inappropriate to use Internet-Drafts as reference 27 material or to cite them other than as "work in progress." 29 The list of current Internet-Drafts can be accessed at http:// 30 www.ietf.org/ietf/1id-abstracts.txt. 32 The list of Internet-Draft Shadow Directories can be accessed at 33 http://www.ietf.org/shadow.html. 35 This Internet-Draft will expire on August 6, 2004. 37 Copyright Notice 39 Copyright (C) The Internet Society (2004). All Rights Reserved. 41 Abstract 43 This document specifies a set of methods, headers, properties and 44 content-types composing WebDAV SEARCH, an application of the HTTP/1.1 45 protocol to efficiently search for DAV resources based upon a set of 46 client-supplied criteria. 48 Distribution of this document is unlimited. Please send comments to 49 the Distributed Authoring and Versioning (WebDAV) DASL mailing list 50 at www-webdav-dasl@w3.org [1], which may be joined by sending a 51 message with subject "subscribe" to www-webdav-dasl-request@w3.org 52 [2]. Discussions of the WebDAV DASL mailing list are archived at URL: 53 http://lists.w3.org/Archives/Public/www-webdav-dasl/. 55 Table of Contents 57 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . 5 58 1.1 DASL . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 59 1.2 Relationship to DAV . . . . . . . . . . . . . . . . . . . 5 60 1.3 Terms . . . . . . . . . . . . . . . . . . . . . . . . . . 5 61 1.4 Notational Conventions . . . . . . . . . . . . . . . . . . 7 62 1.5 Editorial note on usage of 'DAV:' namespace . . . . . . . 7 63 1.6 An Overview of DASL at Work . . . . . . . . . . . . . . . 8 64 2. The SEARCH Method . . . . . . . . . . . . . . . . . . . . 9 65 2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . 9 66 2.2 The Request . . . . . . . . . . . . . . . . . . . . . . . 9 67 2.2.1 The Request-URI . . . . . . . . . . . . . . . . . . . . . 9 68 2.2.2 The Request Body . . . . . . . . . . . . . . . . . . . . . 9 69 2.3 The Successful 207 (Multistatus) Response . . . . . . . . 10 70 2.3.1 Extending the PROPFIND Response . . . . . . . . . . . . . 10 71 2.3.2 Example: A Simple Request and Response . . . . . . . . . . 11 72 2.3.3 Example: Result Set Truncation . . . . . . . . . . . . . . 12 73 2.4 Unsuccessful Responses . . . . . . . . . . . . . . . . . . 13 74 2.4.1 Example of an Invalid Scope . . . . . . . . . . . . . . . 13 75 3. Discovery of Supported Query Grammars . . . . . . . . . . 15 76 3.1 The OPTIONS Method . . . . . . . . . . . . . . . . . . . . 15 77 3.2 The DASL Response Header . . . . . . . . . . . . . . . . . 15 78 3.3 DAV:supported-query-grammar-set (protected) . . . . . . . 16 79 3.4 Example: Grammar Discovery . . . . . . . . . . . . . . . . 16 80 4. Query Schema Discovery: QSD . . . . . . . . . . . . . . . 19 81 4.1 Additional SEARCH semantics . . . . . . . . . . . . . . . 19 82 4.1.1 Example of query schema discovery . . . . . . . . . . . . 20 83 5. The DAV:basicsearch Grammar . . . . . . . . . . . . . . . 22 84 5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . 22 85 5.2 The DAV:basicsearch DTD . . . . . . . . . . . . . . . . . 22 86 5.2.1 Example Query . . . . . . . . . . . . . . . . . . . . . . 24 87 5.3 DAV:select . . . . . . . . . . . . . . . . . . . . . . . . 24 88 5.4 DAV:from . . . . . . . . . . . . . . . . . . . . . . . . . 24 89 5.4.1 Relationship to the Request-URI . . . . . . . . . . . . . 25 90 5.4.2 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . 25 91 5.5 DAV:where . . . . . . . . . . . . . . . . . . . . . . . . 25 92 5.5.1 Use of Three-Valued Logic in Queries . . . . . . . . . . . 26 93 5.5.2 Handling Optional operators . . . . . . . . . . . . . . . 26 94 5.5.3 Treatment of NULL Values . . . . . . . . . . . . . . . . . 26 95 5.5.4 Treatment of properties with mixed/element content . . . . 26 96 5.5.5 Example: Testing for Equality . . . . . . . . . . . . . . 26 97 5.5.6 Example: Relative Comparisons . . . . . . . . . . . . . . 27 98 5.6 DAV:orderby . . . . . . . . . . . . . . . . . . . . . . . 27 99 5.6.1 Comparing Natural Language Strings . . . . . . . . . . . . 28 100 5.6.2 Example of Sorting . . . . . . . . . . . . . . . . . . . . 28 101 5.7 Boolean Operators: DAV:and, DAV:or, and DAV:not . . . . . 28 102 5.8 DAV:eq . . . . . . . . . . . . . . . . . . . . . . . . . . 28 103 5.9 DAV:lt, DAV:lte, DAV:gt, DAV:gte . . . . . . . . . . . . . 29 104 5.10 DAV:literal . . . . . . . . . . . . . . . . . . . . . . . 29 105 5.11 DAV:typed-literal (optional) . . . . . . . . . . . . . . . 29 106 5.11.1 Example for typed numerical comparison . . . . . . . . . . 30 107 5.12 Support for matching xml:lang attributes on properties . . 30 108 5.12.1 DAV:language-defined (optional) . . . . . . . . . . . . . 30 109 5.12.2 DAV:language-matches (optional) . . . . . . . . . . . . . 31 110 5.12.3 Example of language-aware matching . . . . . . . . . . . . 31 111 5.13 DAV:is-collection . . . . . . . . . . . . . . . . . . . . 31 112 5.13.1 Example of DAV:is-collection . . . . . . . . . . . . . . . 31 113 5.14 DAV:is-defined . . . . . . . . . . . . . . . . . . . . . . 32 114 5.15 DAV:like . . . . . . . . . . . . . . . . . . . . . . . . . 32 115 5.15.1 Syntax for the Literal Pattern . . . . . . . . . . . . . . 32 116 5.15.2 Example of DAV:like . . . . . . . . . . . . . . . . . . . 33 117 5.16 DAV:contains . . . . . . . . . . . . . . . . . . . . . . . 33 118 5.16.1 Result scoring (DAV:score element) . . . . . . . . . . . . 34 119 5.16.2 Ordering by score . . . . . . . . . . . . . . . . . . . . 34 120 5.16.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . 34 121 5.17 Limiting the result set . . . . . . . . . . . . . . . . . 35 122 5.17.1 Relationship to result ordering . . . . . . . . . . . . . 35 123 5.18 The 'caseless' XML attribute . . . . . . . . . . . . . . . 35 124 5.19 Query schema for DAV:basicsearch . . . . . . . . . . . . . 35 125 5.19.1 DTD for DAV:basicsearch QSD . . . . . . . . . . . . . . . 36 126 5.19.2 DAV:propdesc Element . . . . . . . . . . . . . . . . . . . 36 127 5.19.3 The DAV:datatype Property Description . . . . . . . . . . 37 128 5.19.4 The DAV:searchable Property Description . . . . . . . . . 37 129 5.19.5 The DAV:selectable Property Description . . . . . . . . . 37 130 5.19.6 The DAV:sortable Property Description . . . . . . . . . . 38 131 5.19.7 The DAV:caseless Property Description . . . . . . . . . . 38 132 5.19.8 The DAV:operators XML Element . . . . . . . . . . . . . . 38 133 5.19.9 Example of Query Schema for DAV:basicsearch . . . . . . . 39 134 6. Internationalization Considerations . . . . . . . . . . . 40 135 7. Security Considerations . . . . . . . . . . . . . . . . . 41 136 7.1 Implications of XML External Entities . . . . . . . . . . 41 137 8. Scalability . . . . . . . . . . . . . . . . . . . . . . . 42 138 9. Authentication . . . . . . . . . . . . . . . . . . . . . . 43 139 10. IANA Considerations . . . . . . . . . . . . . . . . . . . 44 140 11. Contributors . . . . . . . . . . . . . . . . . . . . . . . 45 141 12. Acknowledgements . . . . . . . . . . . . . . . . . . . . . 46 142 Normative References . . . . . . . . . . . . . . . . . . . 47 143 Informative References . . . . . . . . . . . . . . . . . . 48 144 Authors' Addresses . . . . . . . . . . . . . . . . . . . . 49 145 A. Three-Valued Logic in DAV:basicsearch . . . . . . . . . . 50 146 B. Change Log (to be removed by RFC Editor before 147 publication) . . . . . . . . . . . . . . . . . . . . . . . 52 148 B.1 From draft-davis-dasl-protocol-xxx . . . . . . . . . . . . 52 149 B.2 since start of draft-reschke-webdav-search . . . . . . . . 53 150 B.3 since draft-reschke-webdav-search-00 . . . . . . . . . . . 55 151 B.4 since draft-reschke-webdav-search-01 . . . . . . . . . . . 55 152 B.5 since draft-reschke-webdav-search-02 . . . . . . . . . . . 56 153 B.6 since draft-reschke-webdav-search-03 . . . . . . . . . . . 56 154 B.7 since draft-reschke-webdav-search-04 . . . . . . . . . . . 57 155 B.8 since draft-reschke-webdav-search-05 . . . . . . . . . . . 57 156 C. Resolved issues (to be removed by RFC Editor before 157 publication) . . . . . . . . . . . . . . . . . . . . . . . 59 158 C.1 5.4.2-multiple-scope . . . . . . . . . . . . . . . . . . . 59 159 D. Open issues (to be removed by RFC Editor prior to 160 publication) . . . . . . . . . . . . . . . . . . . . . . . 60 161 D.1 1.3-apply-condition-code-terminology . . . . . . . . . . . 60 162 D.2 2.4-multiple-uris . . . . . . . . . . . . . . . . . . . . 60 163 D.3 result-truncation . . . . . . . . . . . . . . . . . . . . 60 164 D.4 qsd-optional . . . . . . . . . . . . . . . . . . . . . . . 61 165 D.5 5.1-name-filtering . . . . . . . . . . . . . . . . . . . . 61 166 D.6 5_media_type_match . . . . . . . . . . . . . . . . . . . . 62 167 D.7 5.4.2-scope-vs-redirects . . . . . . . . . . . . . . . . . 62 168 D.8 language-comparison . . . . . . . . . . . . . . . . . . . 62 169 D.9 JW16b/JW24a . . . . . . . . . . . . . . . . . . . . . . . 63 170 D.10 typed-literal . . . . . . . . . . . . . . . . . . . . . . 63 171 Index . . . . . . . . . . . . . . . . . . . . . . . . . . 64 172 Intellectual Property and Copyright Statements . . . . . . 66 174 1. Introduction 176 1.1 DASL 178 This document defines WebDAV SEARCH, an application of HTTP/1.1 179 forming a lightweight search protocol to transport queries and result 180 sets and allows clients to make use of server-side search facilities. 181 It is based on the expired draft for WebDAV DASL [DASL]. [DASLREQ] 182 describes the motivation for DASL. 184 DASL will minimize the complexity of clients so as to facilitate 185 widespread deployment of applications capable of utilizing the DASL 186 search mechanisms. 188 DASL consists of: 190 o the SEARCH method, 192 o the DASL response header, 194 o the DAV:searchrequest XML element, 196 o the DAV:query-schema-discovery XML element, 198 o the DAV:basicsearch XML element and query grammar, and 200 o the DAV:basicsearchschema XML element. 202 For WebDAV-compliant servers, it also defines a new live property 203 DAV:supported-query-grammar-set. 205 1.2 Relationship to DAV 207 DASL relies on the resource and property model defined by [RFC2518]. 208 DASL does not alter this model. Instead, DASL allows clients to 209 access DAV-modeled resources through server-side search. 211 1.3 Terms 213 This document uses the terms defined in [RFC2616], in [RFC2518], in 214 [RFC3253] and in this section. 216 Criteria 218 An expression against which each resource in the search scope is 219 evaluated. 221 Query 222 A query is a combination of a search scope, search criteria, 223 result record definition, sort specification, and a search 224 modifier. 226 Query Grammar 228 A set of definitions of XML elements, attributes, and constraints 229 on their relations and values that defines a set of queries and 230 the intended semantics. 232 Query Schema 234 A listing, for any given grammar and scope, of the properties and 235 operators that may be used in a query with that grammar and scope. 237 Result 239 A result is a result set, optionally augmented with other 240 information describing the search as a whole. 242 Result Record 244 A description of a resource. A result record is a set of 245 properties, and possibly other descriptive information. 247 Result Record Definition 249 A specification of the set of properties to be returned in the 250 result record. 252 Result Set 254 A set of records, one for each resource for which the search 255 criteria evaluated to True. 257 Scope 259 A set of resources to be searched. 261 Search Modifier 263 An instruction that governs the execution of the query but is not 264 part of the search scope, result record definition, the search 265 criteria, or the sort specification. An example of a search 266 modifier is one that controls how much time the server can spend 267 on the query before giving a response. 269 Sort Specification 270 A specification of an ordering on the result records in the result 271 set. 273 1.4 Notational Conventions 275 The augmented BNF used by this document to describe protocol elements 276 is exactly the same as the one described in Section 2.1 of [RFC2616]. 277 Because this augmented BNF uses the basic production rules provided 278 in Section 2.2 of [RFC2616], those rules apply to this document as 279 well. 281 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT" 282 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 283 document are to be interpreted as described in [RFC2119]. 285 This document uses XML DTD fragments as a purely notational 286 convention. WebDAV request and response bodies can not be validated 287 due to the specific extensibility rules defined in section 23 of 288 [RFC2518] and due to the fact that all XML elements defined by this 289 specification use the XML namespace name "DAV:". In particular: 291 1. element names use the "DAV:" namespace, 293 2. element ordering is irrelevant unless explicitly stated, 295 3. extension elements (elements not already defined as valid child 296 elements) may be added anywhere, except when explicitly stated 297 otherwise, 299 4. extension attributes (attributes not already defined as valid for 300 this element) may be added anywhere, except when explicitly 301 stated otherwise. 303 When an XML element type in the "DAV:" namespace is referenced in 304 this document outside of the context of an XML fragment, the string 305 "DAV:" will be prefixed to the element type. 307 Similarily, when an XML element type in the namespace "http:// 308 www.w3.org/2001/XMLSchema" is referenced in this document outside of 309 the context of an XML fragment, the string "xs:" will be prefixed to 310 the element type. 312 1.5 Editorial note on usage of 'DAV:' namespace 314 *Note that this draft currently defines elements and properties in 315 the WebDAV namespace "DAV:" which it shouldn't do as it isn't a work 316 item of the WebDAV working group. The reason for this is the desire 317 for some kind of backward compatibility to the expired DASL drafts 318 and the assumption that the draft may become an official RFC 319 submission of the WebDAV working group at a later point of time.* 321 1.6 An Overview of DASL at Work 323 One can express the basic usage of DASL in the following steps: 325 o The client constructs a query using the DAV:basicsearch grammar. 327 o The client invokes the SEARCH method on a resource that will 328 perform the search (the search arbiter) and includes a text/xml or 329 application/xml request entity that contains the query. 331 o The search arbiter performs the query. 333 o The search arbiter sends the results of the query back to the 334 client in the response. The server MUST send an entity that 335 matches the [RFC2518] PROPFIND response. 337 2. The SEARCH Method 339 2.1 Overview 341 The client invokes the SEARCH method to initiate a server-side 342 search. The body of the request defines the query. The server MUST 343 emit an entity matching the [RFC2518] PROPFIND response. 345 The SEARCH method plays the role of transport mechanism for the query 346 and the result set. It does not define the semantics of the query. 347 The type of the query defines the semantics. 349 2.2 The Request 351 The client invokes the SEARCH method on the resource named by the 352 Request-URI. 354 2.2.1 The Request-URI 356 The Request-URI identifies the search arbiter. Any HTTP resource may 357 function as search arbiter. It is not a new type of resource (in the 358 sense of DAV:resourcetype as defined in [RFC2518]), nor does it have 359 to be a WebDAV-compliant resource. 361 The SEARCH method defines no relationship between the arbiter and the 362 scope of the search, rather the particular query grammar used in the 363 query defines the relationship. For example, a query grammar may 364 force the request-URI to correspond exactly to the search scope. 366 2.2.2 The Request Body 368 The server MUST process a text/xml or application/xml request body, 369 and MAY process request bodies in other formats. See [RFC3023] for 370 guidance on packaging XML in requests. 372 Marshalling: 374 If a request body with content type text/xml or application/xml is 375 included, it MUST be either a DAV:searchrequest or a 376 DAV:query-schema-discovery XML element. It's single child element 377 identifies the query grammar. 379 For DAV:searchrequest, the definition of search criteria, the 380 result record, and any other details needed to perform the search 381 depend on the individual search grammar. 383 For DAV:query-schema-discovery, the semantics is defined in 384 Section 4. 386 Preconditions: 388 (DAV:search-grammar-discovery-supported): when an XML request body 389 is present and has a DAV:query-schema-discovery document element, 390 the server MUST support the query schema discovery mechanism 391 described in Section 4. 393 (DAV:search-grammar-supported): when an XML request body is 394 present, the search grammar identified by the document element's 395 child element must be a supported search grammar. 397 (DAV:search-multiple-scope-supported): if the SEARCH request 398 specified multiple scopes, the server MUST support this optional 399 feature. 401 (DAV:search-scope-valid): the supplied search scope must be valid. 402 There can be various reasons for a search scope to be invalid, 403 including unsupported URI schemes and communication problems. 404 Servers MAY add [RFC2518] compliant DAV:response elements as 405 content to the condition element indicating the precise reason for 406 the failure. 408 2.3 The Successful 207 (Multistatus) Response 410 If the server returns 207 (Multistatus), then the search proceeded 411 successfully and the response MUST match that of a PROPFIND. The 412 results of this method SHOULD NOT be cached. 414 There MUST be one DAV:response for each resource that matched the 415 search criteria. For each such response, the DAV:href element 416 contains the URI of the resource, and the response MUST include a 417 DAV:propstat element. 419 Note that for each matching resource found there may be multiple URIs 420 within the search scope mapped to it. In this case, a server SHOULD 421 report all of these URIs. Clients can use the live property 422 DAV:resource-id defined in [BIND] to identify possible duplicates. 424 2.3.1 Extending the PROPFIND Response 426 A response MAY include more information than PROPFIND defines so long 427 as the extra information does not invalidate the PROPFIND response. 428 Query grammars SHOULD define how the response matches the PROPFIND 429 response. 431 2.3.2 Example: A Simple Request and Response 433 This example demonstrates the request and response framework. The 434 following XML document shows a simple (hypothetical) natural language 435 query. The name of the query element is natural-language-query in the 436 XML namespace "http://example.com/foo". The actual query is "Find the 437 locations of good Thai restaurants in Los Angeles". For this 438 hypothetical query, the arbiter returns two properties for each 439 selected resource. 441 >> Request: 443 SEARCH / HTTP/1.1 444 Host: example.org 445 Content-Type: application/xml 446 Content-Length: xxx 448 449 450 451 Find the locations of good Thai restaurants in Los Angeles 452 453 455 >> Response: 457 HTTP/1.1 207 Multi-Status 458 Content-Type: text/xml; charset="utf-8" 459 Content-Length: xxx 461 462 464 465 http://siamiam.test/ 466 467 468 259 W. Hollywood 469 4 470 471 HTTP/1.1 200 OK 472 473 474 476 2.3.3 Example: Result Set Truncation 478 A server MAY limit the number of resources in a reply, for example to 479 limit the amount of resources expended in processing a query. If it 480 does so, the reply MUST use status code 207, return a DAV:multistatus 481 response body and indicate a status of 507 (Insufficient Storage) for 482 the search arbiter URI. It SHOULD include the partial results. 484 When a result set is truncated, there may be many more resources that 485 satisfy the search criteria but that were not examined. 487 If partial results are included and the client requested an ordered 488 result set in the original request, then any partial results that are 489 returned MUST be ordered as the client directed. 491 Note that the partial results returned MAY be any subset of the 492 result set that would have satisfied the original query. 494 >> Request: 496 SEARCH / HTTP/1.1 497 Host: example.net 498 Content-Type: text/xml; charset="utf-8" 499 Content-Length: xxx 501 ... the query goes here ... 503 >> Response: 505 HTTP/1.1 207 Multistatus 506 Content-Type: text/xml; charset="utf-8" 507 Content-Length: xxx 509 510 511 512 http://www.example.net/sounds/unbrokenchain.au 513 514 515 HTTP/1.1 200 OK 516 517 518 519 http://tech.mit.test/archive96/photos/Lesh1.jpg 520 521 522 HTTP/1.1 200 OK 523 524 525 526 http://example.net 527 HTTP/1.1 507 Insufficient Storage 528 529 Only first two matching records were returned 530 531 532 534 2.4 Unsuccessful Responses 536 If a SEARCH request could not be executed or the attempt to execute 537 it resulted in an error, the server MUST indicate the failure with an 538 appropriate status code and SHOULD add a response body as defined in 539 [RFC3253], section 1.6. Unless otherwise stated, condition elements 540 are empty, however specific conditions element MAY include additional 541 child elements that describe the error condition in more detail. 543 2.4.1 Example of an Invalid Scope 545 In the example below, a request failed because the scope identifies a 546 HTTP resource that was not found. 548 >> Response: 550 HTTP/1.1 409 Conflict 551 Content-Type: text/xml; charset="utf-8" 552 Content-Length: xxx 554 555 556 557 558 http://www.example.com/X 559 HTTP/1.1 404 Object Not Found 560 561 562 564 3. Discovery of Supported Query Grammars 566 Servers MUST support discovery of the query grammars supported by a 567 search arbiter resource. 569 Clients can determine which query grammars are supported by an 570 arbiter by invoking OPTIONS on the search arbiter. If the resource 571 supports SEARCH, then the DASL response header will appear in the 572 response. The DASL response header lists the supported grammars. 574 Servers supporting the WebDAV extensions [RFC3253] and/or [ACL] MUST 575 also 577 o report SEARCH in the live property DAV:supported-method-set for 578 all search arbiter resources and 580 o support the live property DAV:supported-query-grammar-set as 581 defined in Section 3.3. 583 3.1 The OPTIONS Method 585 The OPTIONS method allows the client to discover if a resource 586 supports the SEARCH method and to determine the list of search 587 grammars supported for that resource. 589 The client issues the OPTIONS method against a resource named by the 590 Request-URI. This is a normal invocation of OPTIONS defined in 591 [RFC2616]. 593 If a resource supports the SEARCH method, then the server MUST list 594 SEARCH in the OPTIONS response as defined by [RFC2616]. 596 DASL servers MUST include the DASL header in the OPTIONS response. 597 This header identifies the search grammars supported by that 598 resource. 600 3.2 The DASL Response Header 602 DASLHeader = "DASL" ":" Coded-URL-List 603 Coded-URL-List : Coded-URL [ "," Coded-URL-List ] 604 Coded-URL ; defined in section 9.4 of [RFC2518] 606 The DASL response header indicates server support for a query grammar 607 in the OPTIONS method. The value is a URI that indicates the type of 608 grammar. Note that although the URI can be used to identify each 609 supported search grammar, there is not necessarily a direct 610 relationship between the URI and the XML element name that can be 611 used in XML based SEARCH requests (the element name itself is 612 identified by it's namespace name (a URI reference) and the element's 613 local name). 615 This header MAY be repeated. 617 For example: 619 DASL: 620 DASL: 621 DASL: 622 DASL: 624 3.3 DAV:supported-query-grammar-set (protected) 626 This WebDAV property is required for any server supporting either 627 [RFC3253] and/or [ACL] and identifies the XML based query grammars 628 that are supported by the search arbiter resource. 630 631 632 634 ANY value: a query grammar element type 636 3.4 Example: Grammar Discovery 638 This example shows that the server supports search on the /somefolder 639 resource with the query grammars: DAV:basicsearch, http:// 640 foobar.test/syntax1 and http://akuma.test/syntax2. Note that every 641 server MUST support DAV:basicsearch. 643 >> Request: 645 OPTIONS /somefolder HTTP/1.1 646 Host: example.org 648 >> Response: 650 HTTP/1.1 200 OK 651 Allow: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE 652 Allow: MKCOL, PROPFIND, PROPPATCH, LOCK, UNLOCK, SEARCH 653 DASL: 654 DASL: 655 DASL: 657 This example shows the equivalent taking advantage of a server's 658 support for DAV:supported-method-set and 659 DAV:supported-query-grammar-set. 661 >> Request: 663 PROPFIND /somefolder HTTP/1.1 664 Host: example.org 665 Depth: 0 666 Content-Type: text/xml; charset="utf-8" 667 Content-Length: xxx 669 670 671 672 673 674 675 677 >> Response: 679 HTTP/1.1 207 Multi-Status 680 Content-Type: text/xml; charset="utf-8" 681 Content-Length: xxx 683 684 685 686 http://example.org/somefolder 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 HTTP/1.1 200 OK 719 720 721 723 Note that the query grammar element names marshalled as part of the 724 DAV:supported-query-grammar-set can be directly used as element names 725 in an XML based query. 727 4. Query Schema Discovery: QSD 729 Servers MAY support the discovery of the schema for a query grammar. 731 The DASL response header and the DAV:supported-query-grammar-set 732 property provide means for clients to discover the set of query 733 grammars supported by a resource. This alone is not sufficient 734 information for a client to generate a query. For example, the 735 DAV:basicsearch grammar defines a set of queries consisting of a set 736 of operators applied to a set of properties and values, but the 737 grammar itself does not specify which properties may be used in the 738 query. QSD for the DAV:basicsearch grammar allows a client to 739 discover the set of properties that are searchable, selectable, and 740 sortable. Moreover, although the DAV:basicsearch grammar defines a 741 minimal set of operators, it is possible that a resource might 742 support additional operators in a query. For example, a resource 743 might support a optional operator that can be used to express 744 content-based queries in a proprietary syntax. QSD allows a client to 745 discover these operators and their syntax. The set of discoverable 746 quantities will differ from grammar to grammar, but each grammar can 747 define a means for a client to discover what can be discovered. 749 In general, the schema for a given query grammar depends on both the 750 resource (the arbiter) and the scope. A given resource might have 751 access to one set of properties for one potential scope, and another 752 set for a different scope. For example, consider a server able to 753 search two distinct collections, one holding cooking recipes, the 754 other design documents for nuclear weapons. While both collections 755 might support properties such as author, title, and date, the first 756 might also define properties such as calories and preparation time, 757 while the second defined properties such as yield and applicable 758 patents. Two distinct arbiters indexing the same collection might 759 also have access to different properties. For example, the recipe 760 collection mentioned above might also indexed by a value-added server 761 that also stored the names of chefs who had tested the recipe. Note 762 also that the available query schema might also depend on other 763 factors, such as the identity of the principal conducting the search, 764 but these factors are not exposed in this protocol. 766 4.1 Additional SEARCH semantics 768 Each query grammar supported by DASL defines its own syntax for 769 expressing the possible query schema. A client retrieves the schema 770 for a given query grammar on an arbiter resource with a given scope 771 by invoking the SEARCH method on that arbiter with that grammar and 772 scope and with a root element of DAV:query-schema-discovery rather 773 than DAV:searchrequest. 775 Marshalling: 777 The request body MUST be DAV:query-schema-discovery element. 779 780 ANY value: XML element defining a valid query 782 The response body takes the form of a RFC2518 DAV:multistatus 783 element, where DAV:response is extended to hold the returned query 784 grammar inside a DAV:query-schema container element. 786 788 790 The content of this container is an XML element whose name and syntax 791 depend upon the grammar, and whose value may (and likely will) vary 792 depending upon the grammar, arbiter, and scope. 794 4.1.1 Example of query schema discovery 796 In this example, the arbiter is recipes.test, the grammar is 797 DAV:basicsearch, the scope is also recipes.test. 799 >> Request: 801 SEARCH / HTTP/1.1 802 Host: recipes.test 803 Content-Type: application/xml 804 Content-Length: xxx 806 807 808 809 810 811 http://recipes.test 812 infinity 813 814 815 816 817 >> Response: 819 HTTP/1.1 207 Multistatus 820 Content-Type: application/xml 821 Content-Length: xxx 823 824 825 826 http://recipes.test 827 HTTP/1.1 200 OK 828 829 830 832 833 834 835 837 The query schema for DAV:basicsearch is defined in Section 5.19. 839 5. The DAV:basicsearch Grammar 841 5.1 Introduction 843 DAV:basicsearch uses an extensible XML syntax that allows clients to 844 express search requests that are generally useful for WebDAV 845 scenarios. DASL-extended servers MUST accept this grammar, and MAY 846 accept other grammars. 848 DAV:basicsearch has several components: 850 o DAV:select provides the result record definition. 852 o DAV:from defines the scope. 854 o DAV:where defines the criteria. 856 o DAV:orderby defines the sort order of the result set. 858 o DAV:limit provides constraints on the query as a whole. 860 5.2 The DAV:basicsearch DTD 862 864 866 868 870 872 873 875 877 878 879 881 882 884 887 889 891 893 895 896 898 899 901 902 904 905 907 908 910 911 912 914 915 917 918 920 921 923 925 927 928 930 931 932 934 935 937 5.2.1 Example Query 939 This query retrieves the content length values for all resources 940 located under the server's "/container1/" URI namespace whose length 941 exceeds 10000. 943 944 945 946 947 948 949 950 /container1/ 951 infinity 952 953 954 955 956 957 10000 958 959 960 961 962 963 964 965 966 967 969 5.3 DAV:select 971 DAV:select defines the result record, which is a set of properties 972 and values. This document defines two possible values: DAV:allprop 973 and DAV:prop, both defined in [RFC2518] and revised in [RFC3253]. 975 5.4 DAV:from 977 978 980 DAV:from defines the query scope. This contains one or more DAV:scope 981 elements. Support for multiple scope elements is optional, however 982 servers MUST fail a request specifying multiple DAV:scope elements if 983 they can't support it (see Section 2.2.2, precondition 984 DAV:search-multiple-scope-supported). The scope element contains 985 mandatory DAV:href and DAV:depth elements. 987 DAV:href indicates the URI to use as a scope. 989 When the scope is a collection, if DAV:depth is "0", the search 990 includes only the collection. When it is "1", the search includes the 991 (toplevel) members of the collection. When it is "infinity", the 992 search includes all recursive members of the collection. 994 When the scope is not a collection, the depth is ignored and the 995 search applies just to the resource itself. 997 When the child element DAV:include-versions is present, the search 998 scope will include all versions (see [RFC3253], section 2.2.1) of all 999 version-controlled resources in scope. Servers that do support 1000 versioning but do not support the DAV:include-versions feature MUST 1001 signal an error if it is used in a query. 1003 5.4.1 Relationship to the Request-URI 1005 If the DAV:scope element is an absolute URI, the scope is exactly 1006 that URI. 1008 If the DAV:scope element is is an absolute URI reference, the scope 1009 is taken to be relative to the request-URI. 1011 5.4.2 Scope 1013 A Scope can be an arbitrary URI. 1015 Servers, of course, may support only particular scopes. This may 1016 include limitations for particular schemes such as "http:" or "ftp:" 1017 or certain URI namespaces. 1019 5.5 DAV:where 1021 The DAV:where element defines the search condition for inclusion of 1022 resources in the result set. The value of this element is an XML 1023 element that defines a search operator that evaluates to one of the 1024 Boolean truth values TRUE, FALSE, or UNKNOWN. The search operator 1025 contained by DAV:where may itself contain and evaluate additional 1026 search operators as operands, which in turn may contain and evaluate 1027 additional search operators as operands, etc. recursively. 1029 5.5.1 Use of Three-Valued Logic in Queries 1031 Each operator defined for use in the where clause that returns a 1032 Boolean value MUST evaluate to TRUE, FALSE, or UNKNOWN. The resource 1033 under scan is included as a member of the result set if and only if 1034 the search condition evaluates to TRUE. 1036 Consult Appendix A for details on the application of three-valued 1037 logic in query expressions. 1039 5.5.2 Handling Optional operators 1041 If a query contains an operator that is not supported by the server, 1042 then the server MUST respond with a 422 (Unprocessable Entity) status 1043 code. 1045 5.5.3 Treatment of NULL Values 1047 If a PROPFIND for a property value would yield a non-2xx (see 1048 [RFC2616], section 10.2) response for that property, then that 1049 property is considered NULL. 1051 NULL values are "less than" all other values in comparisons. 1053 Empty strings (zero length strings) are not NULL values. An empty 1054 string is "less than" a string with length greater than zero. 1056 The DAV:is-defined operator is defined to test if the value of a 1057 property is NULL. 1059 5.5.4 Treatment of properties with mixed/element content 1061 Comparisons of properties that do not have simple types (text-only 1062 content) is out-of-scope for the standard operators defined for 1063 DAV:basicsearch and therefore is defined to be UNKNOWN (as per 1064 Appendix A). For querying the DAV:resourcetype property, see Section 1065 5.13. 1067 5.5.5 Example: Testing for Equality 1069 The example shows a single operator (DAV:eq) applied in the criteria. 1071 1072 1073 1074 1075 1076 100 1077 1078 1080 5.5.6 Example: Relative Comparisons 1082 The example shows a more complex operation involving several 1083 operators (DAV:and, DAV:eq, DAV:gt) applied in the criteria. This 1084 DAV:where expression matches those resources that are "image/gifs" 1085 over 4K in size. 1087 1088 1089 1090 1091 1092 1093 image/gif 1094 1095 1096 1097 1098 1099 4096 1100 1101 1102 1104 5.6 DAV:orderby 1106 The DAV:orderby element specifies the ordering of the result set. It 1107 contains one or more DAV:order elements, each of which specifies a 1108 comparison between two items in the result set. Informally, a 1109 comparison specifies a test that determines whether one resource 1110 appears before another in the result set. Comparisons are applied in 1111 the order they occur in the DAV:orderby element, earlier comparisons 1112 being more significant. 1114 The comparisons defined here use only a single property from each 1115 resource, compared using the same ordering as the DAV:lt operator 1116 (ascending) or DAV:gt operator (descending). If neither direction is 1117 specified, the default is DAV:ascending. 1119 In the context of the DAV:orderby element, null values are considered 1120 to collate before any actual (i.e., non null) value, including 1121 strings of zero length (this is compatible with [SQL99]). 1123 5.6.1 Comparing Natural Language Strings 1125 Comparisons on strings take into account the language defined for 1126 that property. Clients MAY specify the language using the xml:lang 1127 attribute. If no language is specified either by the client or 1128 defined for that property by the server or if a comparison is 1129 performed on strings of two different languages, the results are 1130 undefined. 1132 The "caseless" attribute may be used to indicate case-sensitivity for 1133 comparisons. 1135 5.6.2 Example of Sorting 1137 This sort orders first by last name of the author, and then by size, 1138 in descending order, so that for each author, the largest works 1139 appear first. 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1152 5.7 Boolean Operators: DAV:and, DAV:or, and DAV:not 1154 The DAV:and operator performs a logical AND operation on the 1155 expressions it contains. 1157 The DAV:or operator performs a logical OR operation on the values it 1158 contains. 1160 The DAV:not operator performs a logical NOT operation on the values 1161 it contains. 1163 5.8 DAV:eq 1165 The DAV:eq operator provides simple equality matching on property 1166 values. 1168 The "caseless" attribute may be used with this element. 1170 5.9 DAV:lt, DAV:lte, DAV:gt, DAV:gte 1172 The DAV:lt, DAV:lte, DAV:gt, and DAV:gte operators provide 1173 comparisons on property values, using less-than, less-than or equal, 1174 greater-than, and greater-than or equal respectively. The "caseless" 1175 attribute may be used with these elements. 1177 5.10 DAV:literal 1179 DAV:literal allows literal values to be placed in an expression. 1181 White space in literal values is significant in comparisons. For 1182 consistency with [RFC2518], clients SHOULD NOT specify the attribute 1183 "xml:space" (section 2.10 of [XML]) to override this behaviour. 1185 In comparisons, the contents of DAV:literal SHOULD be treated as 1186 string, with the following exceptions: 1188 o when operand for a comparison with a DAV:getcontentlength 1189 property, it SHOULD be treated as an integer value (the behaviour 1190 for non-integer values is undefined), 1192 o when operand for a comparison with a DAV:creationdate or 1193 DAV:getlastmodified property, it SHOULD be treated as a date value 1194 in the ISO-8601 subset defined for the DAV:creationdate property 1195 ([RFC2518], section 13.1). 1197 o when operand for a comparison with a property for which the type 1198 is known, it MAY be treated according to this type. 1200 5.11 DAV:typed-literal (optional) 1202 There are situations in which a client may want to force a comparison 1203 not to be string-based (as defined for DAV:literal). In these cases, 1204 a typed comparison can be enforced by using DAV:typed-literal 1205 instead. 1207 1209 The data type is specified using the xsi:type attribute defined in 1210 [XS1], section 2.6.1. If the type is not specified, it defaults to 1211 "xs:string". 1213 A server MUST reject a request with an unknown type. 1215 5.11.1 Example for typed numerical comparison 1217 Consider a set of resources with the dead property "edits" in the 1218 namespace "http://ns.example.org": 1220 +-----+----------------+ 1221 | URI | property value | 1222 +-----+----------------+ 1223 | /a | "-1" | 1224 | | | 1225 | /b | "01" | 1226 | | | 1227 | /c | "3" | 1228 | | | 1229 | /d | "test" | 1230 | | | 1231 | /e | (undefined) | 1232 +-----+----------------+ 1234 The expression 1236 1239 1240 3 1241 1243 will evaluate to TRUE for the resources "/a" and "/b" (their property 1244 values can be parsed as type xs:number, and the numerical comparison 1245 evaluates to true), to FALSE for "/c" (property value is compatible, 1246 but numerical comparison evaluates to false) and UNKNOWN for "/d" and 1247 "/e" (the property either is undefined, or its value can not be 1248 parsed as xs:number). 1250 5.12 Support for matching xml:lang attributes on properties 1252 The following two optional operators can be used to express 1253 conditions on the language of a property value (as expressed using 1254 the xml:lang attribute). 1256 5.12.1 DAV:language-defined (optional) 1258 1260 This operator evaluates to TRUE if the language for the value of the 1261 given property is known, FALSE if it isn't and UNKNOWN if the 1262 property itself is not defined. 1264 5.12.2 DAV:language-matches (optional) 1266 1268 This operator evaluates to TRUE if the language for the value of the 1269 given property is known and matches the language name given in the 1270 element, FALSE if it doesn't match and UNKNOWN if the 1271 property itself is not defined. 1273 Languages are considered to match if they are the same, or if the 1274 language of the property value is a sublanguage of the language 1275 specified in the element (see [XPATH], section 4.3, "lang 1276 function"). 1278 5.12.3 Example of language-aware matching 1280 The expression below will evaluate to TRUE if the property "foobar" 1281 exists and it's language is either unknown, English or a sublanguage 1282 of English. 1284 1285 1286 1287 1288 1289 1290 1291 1292 en 1293 1294 1296 5.13 DAV:is-collection 1298 The DAV:is-collection operator allows clients to determine whether a 1299 resource is a collection (that is, whether it's DAV:resourcetype 1300 element contains the element DAV:collection). 1302 Rationale: This operator is provided in lieu of defining generic 1303 structure queries, which would suffice for this and for many more 1304 powerful queries, but seems inappropriate to standardize at this 1305 time. 1307 5.13.1 Example of DAV:is-collection 1309 This example shows a search criterion that picks out all and only the 1310 resources in the scope that are collections. 1312 1313 1314 1316 5.14 DAV:is-defined 1318 The DAV:is-defined operator allows clients to determine whether a 1319 property is defined on a resource. The meaning of "defined on a 1320 resource" is found in Section 5.5.3. 1322 Example: 1324 1325 1326 1328 5.15 DAV:like 1330 The DAV:like is an optional operator intended to give simple 1331 wildcard-based pattern matching ability to clients. 1333 The operator takes two arguments. 1335 The first argument is a DAV:prop element identifying a single 1336 property to evaluate. 1338 The second argument is a DAV:literal element that gives the pattern 1339 matching string. 1341 5.15.1 Syntax for the Literal Pattern 1343 Pattern := [wildcard] 0*( text [wildcard] ) 1344 wildcard := exactlyone | zeroormore 1345 text := 1*( | escapesequence ) 1346 exactlyone : = "_" 1347 zeroormore := "%" 1348 escapechar := "\" 1349 escapesequence := "\" ( exactlyone | zeroormore | escapechar ) 1350 character: valid XML characters (see section 2.2 of [XML]), 1351 minus ( exactlyone | zeroormore | escapechar ) 1353 The value for the literal is composed of wildcards separated by 1354 segments of text. Wildcards may begin or end the literal. 1356 The "_" wildcard matches exactly one character. 1358 The "%" wildcard matches zero or more characters 1359 The "\" character is an escape sequence so that the literal can 1360 include >"_" and "%". To include the "\" character in the pattern, 1361 the escape sequence "\\" is used. 1363 5.15.2 Example of DAV:like 1365 This example shows how a client might use DAV:like to identify those 1366 resources whose content type was a subtype of image. 1368 1369 1370 1371 image/% 1372 1373 1375 5.16 DAV:contains 1377 The DAV:contains operator is an optional operator that provides 1378 content-based search capability. This operator implicitly searches 1379 against the text content of a resource, not against content of 1380 properties. The DAV:contains operator is intentionally not overly 1381 constrained, in order to allow the server to do the best job it can 1382 in performing the search. 1384 The DAV:contains operator evaluates to a Boolean value. It evaluates 1385 to TRUE if the content of the resource satisfies the search. 1386 Otherwise, It evaluates to FALSE. 1388 Within the DAV:contains XML element, the client provides a phrase: a 1389 single word or whitespace delimited sequence of words. Servers MAY 1390 ignore punctuation in a phrase. Case-sensitivity is left to the 1391 server. 1393 The following things may or may not be done as part of the search: 1394 Phonetic methods such as "soundex" may or may not be used. Word 1395 stemming may or may not be performed. Thesaurus expansion of words 1396 may or may not be done. Right or left truncation may or may not be 1397 performed. The search may be case insensitive or case sensitive. The 1398 word or words may or may not be interpreted as names. Multiple words 1399 may or may not be required to be adjacent or "near" each other. 1400 Multiple words may or may not be required to occur in the same order. 1401 Multiple words may or may not be treated as a phrase. The search may 1402 or may not be interpreted as a request to find documents "similar" to 1403 the string operand. 1405 5.16.1 Result scoring (DAV:score element) 1407 Servers SHOULD indicate scores for the DAV:contains condition by 1408 adding a DAV:score XML element to the DAV:response element. It's 1409 value is defined only in the context of a particular query result. 1410 The value is a string representing the score, an integer from zero to 1411 10000 inclusive, where a higher value indicates a higher score (e.g. 1412 more relevant). 1414 Modified DTD fragment for DAV:propstat: 1416 1418 1420 Clients should note that, in general, it is not meaningful to compare 1421 the numeric values of scores from two different query results unless 1422 both were executed by the same underlying search system on the same 1423 collection of resources. 1425 5.16.2 Ordering by score 1427 To order search results by their score, the DAV:score element may be 1428 added as child to the DAV:orderby element (in place of a DAV:prop 1429 element). 1431 5.16.3 Examples 1433 The example below shows a search for the phrase "Peter Forsberg". 1435 Depending on its support for content-based searching, a server MAY 1436 treat this as a search for documents that contain the words "Peter" 1437 and "Forsberg". 1439 1440 Peter Forsberg 1441 1443 The example below shows a search for resources that contain "Peter" 1444 and "Forsberg". 1446 1447 1448 Peter 1449 Forsberg 1450 1451 1453 5.17 Limiting the result set 1455 1456 ;only digits 1458 The DAV:limit XML element contains requested limits from the client 1459 to limit the size of the reply or amount of effort expended by the 1460 server. The DAV:nresults XML element contains a requested maximum 1461 number of DAV:response elements to be returned in the response body. 1462 The server MAY disregard this limit. The value of this element is an 1463 integer. 1465 5.17.1 Relationship to result ordering 1467 If the result set is both limited by DAV:limit and ordered according 1468 to DAV:orderby, the results that are included in the response 1469 document must be those that order highest. 1471 5.18 The 'caseless' XML attribute 1473 The "caseless" attribute allows clients to specify caseless matching 1474 behaviour instead of character-by-character matching for 1475 DAV:basicsearch operators. 1477 The possible values for "caseless" are "yes" or "no". The default 1478 value is server-specified. Caseless matching SHOULD be implemented as 1479 defined in section 5.18 of the Unicode Standard ([UNICODE4]). 1481 Support for the "caseless" attribute is optional. A server should 1482 respond with a status of 422 if it is used but cannot be supported. 1484 5.19 Query schema for DAV:basicsearch 1486 The DAV:basicsearch grammar defines a search criteria that is a 1487 Boolean-valued expression, and allows for an arbitrary set of 1488 properties to be included in the result record. The result set may be 1489 sorted on a set of property values. Accordingly the DTD for schema 1490 discovery for this grammar allows the server to express: 1492 1. the set of properties that may be either searched, returned, or 1493 used to sort, and a hint about the data type of such properties 1495 2. the set of optional operators defined by the resource. 1497 5.19.1 DTD for DAV:basicsearch QSD 1499 1500 1501 1502 1505 1506 1507 1508 1510 The DAV:properties element holds a list of descriptions of 1511 properties. 1513 The DAV:operators element describes the optional operators that may 1514 be used in a DAV:where element. 1516 5.19.2 DAV:propdesc Element 1518 Each instance of a DAV:propdesc element describes the property or 1519 properties in the DAV:prop element it contains. All subsequent 1520 elements are descriptions that apply to those properties. All 1521 descriptions are optional and may appear in any order. Servers SHOULD 1522 support all the descriptions defined here, and MAY define others. 1524 DASL defines five descriptions. The first, DAV:datatype, provides a 1525 hint about the type of the property value, and may be useful to a 1526 user interface prompting for a value. The remaining four 1527 (DAV:searchable, DAV:selectable, DAV:sortable, and DAV:caseless) 1528 identify portions of the query (DAV:where, DAV:select, and 1529 DAV:orderby, respectively). If a property has a description for a 1530 section, then the server MUST allow the property to be used in that 1531 section. These descriptions are optional. If a property does not have 1532 such a description, or is not described at all, then the server MAY 1533 still allow the property to be used in the corresponding section. 1535 5.19.2.1 DAV:any-other-property 1537 This element can be used in place of DAV:prop to describe properties 1538 of WebDAV properties not mentioned in any other DAV:prop element. For 1539 instance, this can be used to indicate that all other properties are 1540 searchable and selectable without giving details about their types (a 1541 typical scenario for dead properties). 1543 5.19.3 The DAV:datatype Property Description 1545 The DAV:datatype element contains a single XML element that provides 1546 a hint about the domain of the property, which may be useful to a 1547 user interface prompting for a value to be used in a query. Datatypes 1548 are identified by an element name. Where appropriate, a server SHOULD 1549 use the simple datatypes defined in [XS2]. 1551 1553 Examples from [XS2], section 3: 1555 +----------------+---------------------+ 1556 | Qualified name | Example | 1557 +----------------+---------------------+ 1558 | xs:boolean | true, false, 1, 0 | 1559 | | | 1560 | xs:string | Foobar | 1561 | | | 1562 | xs:dateTime | 1994-11-05T08:15:5Z | 1563 | | | 1564 | xs:float | .314159265358979E+1 | 1565 | | | 1566 | xs:integer | -259, 23 | 1567 +----------------+---------------------+ 1569 If the data type of a property is not given, then the data type 1570 defaults to xs:string. 1572 5.19.4 The DAV:searchable Property Description 1574 1576 If this element is present, then the server MUST allow this property 1577 to appear within a DAV:where element where an operator allows a 1578 property. Allowing a search does not mean that the property is 1579 guaranteed to be defined on every resource in the scope, it only 1580 indicates the server's willingness to check. 1582 5.19.5 The DAV:selectable Property Description 1584 1586 This element indicates that the property may appear in the DAV:select 1587 element. 1589 5.19.6 The DAV:sortable Property Description 1591 This element indicates that the property may appear in the 1592 DAV:orderby element. 1594 1596 5.19.7 The DAV:caseless Property Description 1598 This element only applies to properties whose data type is 1599 "xs:string" and derived data types as per the DAV:datatype property 1600 description. Its presence indicates that compares performed for 1601 searches, and the comparisons for ordering results on the string 1602 property will be caseless (the default is character-by-character). 1604 1606 5.19.8 The DAV:operators XML Element 1608 The DAV:operators element describes every optional operator supported 1609 in a query. (Mandatory operators are not listed since they are 1610 mandatory and permit no variation in syntax.). All optional operators 1611 that are supported MUST be listed in the DAV:operators element. The 1612 listing for an operator consists of the operator (as an empty 1613 element), followed by one element for each operand. The operand MUST 1614 be either DAV:operand-property or DAV:operand-literal, which indicate 1615 that the operand in the corresponding position is a property or a 1616 literal value, respectively. If an operator is polymorphic (allows 1617 more than one operand syntax) then each permitted syntax MUST be 1618 listed separately. 1620 1621 1622 1623 1624 1626 5.19.9 Example of Query Schema for DAV:basicsearch 1628 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1656 This response lists four properties. The datatype of the last three 1657 properties is not given, so it defaults to xs:string. All are 1658 selectable, and the first three may be searched. All but the last may 1659 be used in a sort. Of the optional DAV operators, DAV:is-defined and 1660 DAV:like are supported. 1662 Note: The schema discovery defined here does not provide for 1663 discovery of supported values of the "caseless" attribute. This may 1664 require that the reply also list the mandatory operators. 1666 6. Internationalization Considerations 1668 Properties may be language-tagged using the xml:lang attribute (see 1669 [RFC2518], section 4.4). The optional operators DAV:language-defined 1670 (Section 5.12.1) and DAV:language-matches (Section 5.12.2) allow to 1671 express conditions on the language tagging information. 1673 7. Security Considerations 1675 This section is provided to detail issues concerning security 1676 implications of which DASL applications need to be aware. All of the 1677 security considerations of HTTP/1.1 also apply to DASL. In addition, 1678 this section will include security risks inherent in searching and 1679 retrieval of resource properties and content. 1681 A query must not allow one to retrieve information about values or 1682 existence of properties that one could not obtain via PROPFIND. (e.g. 1683 by use in DAV:orderby, or in expressions on properties.) 1685 A server should prepare for denial of service attacks. For example a 1686 client may issue a query for which the result set is expensive to 1687 calculate or transmit because many resources match or must be 1688 evaluated. 1690 7.1 Implications of XML External Entities 1692 XML supports a facility known as "external entities", defined in 1693 section 4.2.2 of [XML], which instruct an XML processor to retrieve 1694 and perform an inline include of XML located at a particular URI. An 1695 external XML entity can be used to append or modify the document type 1696 declaration (DTD) associated with an XML document. An external XML 1697 entity can also be used to include XML within the content of an XML 1698 document. For non-validating XML, such as the XML used in this 1699 specification, including an external XML entity is not required by 1700 [XML]. However, [XML] does state that an XML processor may, at its 1701 discretion, include the external XML entity. 1703 External XML entities have no inherent trustworthiness and are 1704 subject to all the attacks that are endemic to any HTTP GET request. 1705 Furthermore, it is possible for an external XML entity to modify the 1706 DTD, and hence affect the final form of an XML document, in the worst 1707 case significantly modifying its semantics, or exposing the XML 1708 processor to the security risks discussed in [RFC3023]. Therefore, 1709 implementers must be aware that external XML entities should be 1710 treated as untrustworthy. 1712 There is also the scalability risk that would accompany a widely 1713 deployed application which made use of external XML entities. In this 1714 situation, it is possible that there would be significant numbers of 1715 requests for one external XML entity, potentially overloading any 1716 server which fields requests for the resource containing the external 1717 XML entity. 1719 8. Scalability 1721 Query grammars are identified by URIs. Applications SHOULD not 1722 attempt to retrieve these URIs even if they appear to be retrievable 1723 (for example, those that begin with "http://") 1725 9. Authentication 1727 Authentication mechanisms defined in WebDAV will also apply to DASL. 1729 10. IANA Considerations 1731 This document uses the namespace defined by [RFC2518] for XML 1732 elements. All other IANA considerations mentioned in [RFC2518] are 1733 also applicable to DASL. 1735 11. Contributors 1737 This document is based on prior work on the DASL protocol done by the 1738 WebDAV DASL working group until the year 2000 -- namely by Alan 1739 Babich, Jim Davis, Rick Henderson, Dale Lowry, Saveen Reddy and 1740 Surendra Reddy. 1742 12. Acknowledgements 1744 This document has benefited from thoughtful discussion by Lisa 1745 Dusseault, Sung Kim, Elias Sinderson, Martin Wallmer, Jim Whitehead 1746 and Kevin Wiggen. 1748 Normative References 1750 [ACL] Clemm, G., Hopkins, A., Sedlar, E. and J. Whitehead, 1751 "WebDAV Access Control Protocol", ID 1752 draft-ietf-webdav-acl-13, January 2004, . 1755 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1756 Requirement Levels", BCP 14, RFC 2119, March 1997. 1758 [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S. and D. 1759 Jensen, "HTTP Extensions for Distributed Authoring -- 1760 WEBDAV", RFC 2518, February 1999. 1762 [RFC2616] Fielding, R., Gettys, J., Mogul, J., Nielsen, H., 1763 Masinter, L., Leach, P. and T. Berners-Lee, "Hypertext 1764 Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. 1766 [RFC3023] Makoto, M., St.Laurent, S. and D. Kohn, "XML Media Types", 1767 RFC 3023, January 2001. 1769 [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C. and J. 1770 Whitehead, "Versioning Extensions to WebDAV", RFC 3253, 1771 March 2002. 1773 [XML] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E. and 1774 F. Yergeau, "Extensible Markup Language (XML) 1.0 (Third 1775 Edition)", W3C REC-xml-20040204, February 2004, . 1778 [XMLNS] Bray, T., Hollander, D. and A. Layman, "Namespaces in 1779 XML", W3C REC-xml-names-19990114, January 1999, . 1782 [XPATH] Clark, J. and S. DeRose, "XML Path Language (XPath) 1783 Version 1.0", W3C REC REC-xpath-19991116, November 1999, 1784 . 1786 [XS1] Thompson, H., Beech, D., Maloney, M., Mendelsohn, N. and 1787 World Wide Web Consortium, "XML Schema Part 1: 1788 Structures", W3C REC-xmlschema-1-20010502, May 2001, 1789 . 1791 [XS2] Biron, P., Malhotra, A. and World Wide Web Consortium, 1792 "XML Schema Part 2: Datatypes", W3C 1793 REC-xmlschema-2-20010502, May 2001, . 1796 Informative References 1798 [BIND] Clemm, G., Crawford, J., Reschke, J., Slein, J. and J. 1799 Whitehead, "Binding Extensions to WebDAV", ID 1800 draft-ietf-webdav-bind-03, December 2003, . 1803 [DASL] Reddy, S., Lowry, D., Reddy, S., Henderson, R., Davis, J. 1804 and A. Babich, "DAV Searching & Locating", ID 1805 draft-dasl-protocol-00, July 1999, . 1808 [DASLREQ] Davis, J., Reddy, S. and J. Slein, "Requirements for DAV 1809 Searching and Locating", ID draft-dasl-requirements-01, 1810 February 1999, . 1813 [SQL99] Milton, J., "Database Language SQL Part 2: Foundation 1814 (SQL/Foundation)", ISO ISO/IEC 9075-2:1999 (E), July 1999. 1816 [UNICODE4] 1817 The Unicode Consortium, "The Unicode Standard - Version 1818 4.0", Addison-Wesley , August 2003, . 1821 ISBN 0321185781 [3] 1823 URIs 1825 [1] 1827 [2] 1829 [3] 1831 Authors' Addresses 1833 Julian F. Reschke (editor) 1834 greenbytes GmbH 1835 Salzmannstrasse 152 1836 Muenster, NW 48159 1837 Germany 1839 Phone: +49 251 2807760 1840 Fax: +49 251 2807761 1841 EMail: julian.reschke@greenbytes.de 1842 URI: http://greenbytes.de/tech/webdav/ 1844 Surendra Reddy 1845 Oracle Corporation 1846 600 Oracle Parkway, M/S 6op3 1847 Redwoodshores, CA 94065 1849 Phone: +1 650 506 5441 1850 EMail: Surendra.Reddy@oracle.com 1852 Jim Davis 1853 Intelligent Markets 1854 410 Jessie Street 6th floor 1855 San Francisco, CA 94103 1857 EMail: jrd3@alum.mit.edu 1859 Alan Babich 1860 FileNET Corp. 1861 3565 Harbor Blvd. 1862 Costa Mesa, CA 92626 1864 Phone: +1 714 327 3403 1865 EMail: ababich@filenet.com 1867 Appendix A. Three-Valued Logic in DAV:basicsearch 1869 ANSI standard three valued logic is used when evaluating the search 1870 condition (as defined in the ANSI standard SQL specifications, for 1871 example in ANSI X3.135-1992, section 8.12, pp. 188-189, section 8.2, 1872 p. 169, General Rule 1)a), etc.). 1874 ANSI standard three valued logic is undoubtedly the most widely 1875 practiced method of dealing with the issues of properties in the 1876 search condition not having a value (e.g., being null or not defined) 1877 for the resource under scan, and with undefined expressions in the 1878 search condition (e.g., division by zero, etc.). Three valued logic 1879 works as follows. 1881 Undefined expressions are expressions for which the value of the 1882 expression is not defined. Undefined expressions are a completely 1883 separate concept from the truth value UNKNOWN, which is, in fact, 1884 well defined. Property names and literal constants are considered 1885 expressions for purposes of this section. If a property in the 1886 current resource under scan has not been set to a value, then the 1887 value of that property is undefined for the resource under scan. DASL 1888 1.0 has no arithmetic division operator, but if it did, division by 1889 zero would be an undefined arithmetic expression. 1891 If any subpart of an arithmetic, string, or datetime subexpression is 1892 undefined, the whole arithmetic, string, or datetime subexpression is 1893 undefined. 1895 There are no manifest constants to explicitly represent undefined 1896 number, string, or datetime values. 1898 Since a Boolean value is ultimately returned by the search condition, 1899 arithmetic, string, and datetime expressions are always arguments to 1900 other operators. Examples of operators that convert arithmetic, 1901 string, and datetime expressions to Boolean values are the six 1902 relational operators ("greater than", "less than", "equals", etc.). 1903 If either or both operands of a relational operator have undefined 1904 values, then the relational operator evaluates to UNKNOWN. Otherwise, 1905 the relational operator evaluates to TRUE or FALSE, depending upon 1906 the outcome of the comparison. 1908 The Boolean operators DAV:and, DAV:or and DAV:not are evaluated 1909 according to the following rules: 1911 UNKNOWN and UNKNOWN = UNKNOWN 1913 UNKNOWN or UNKNOWN = UNKNOWN 1914 not UNKNOWN = UNKNOWN 1916 UNKNOWN and TRUE = UNKNOWN 1918 UNKNOWN and FALSE = FALSE 1920 UNKNOWN and UNKNOWN = UNKNOWN 1922 UNKNOWN or TRUE = TRUE 1924 UNKNOWN or FALSE = UNKNOWN 1926 UNKNOWN or UNKNOWN = UNKNOWN 1928 Appendix B. Change Log (to be removed by RFC Editor before publication) 1930 B.1 From draft-davis-dasl-protocol-xxx 1932 Feb 14, 1998 Initial Draft 1934 Feb 28, 1998 Referring to DASL as an extension to HTTP/1.1 rather 1935 than DAV. 1936 Added new sections "Notational Conventions", "Protocol Model", 1937 "Security Considerations". 1938 Changed section 3 to "Elements of Protocol". 1939 Added some stuff to introduction. 1940 Added "result set" terminology. 1941 Added "IANA Considerations". 1943 Mar 9, 1998 Moved sub-headings of "Elements of Protocol" to first 1944 level and removed "Elements of Protocol" Heading. 1945 Added an sentence in introduction explaining that this is a 1946 "sketch" of a protocol. 1948 Mar 11, 1998 Added orderby, data typing, three valued logic, query 1949 schema property, and element definitions for schema for 1950 basicsearch. 1952 April 8, 1998 - made changes based on last week's DASL BOF. 1954 May 8, 1998 Removed most of DAV:searcherror; converted to 1955 DAV:searchredirect 1956 Altered DAV:basicsearch grammar to use avoid use of ANY in DTD 1958 June 17, 1998 -Added details on Query Schema Discovery 1959 -Shortened list of data types 1961 June 23, 1998 moved data types before change history 1962 rewrote the data types section 1963 removed the casesensitive element and replace with the 1964 casesensitive attribute 1965 added the casesensitive attribute to the DTD for all operations 1966 that might work on a string 1968 Jul 20, 1998 A series of changes. See Author's meeting minutes for 1969 details. 1971 July 28, 1998 Changes as per author's meeting. QSD uses SEARCH, not 1972 PROPFIND. 1973 Moved text around to keep concepts nearby. 1974 Boolean literals are 1 and 0, not T and F. 1975 contains changed to contentspassthrough. 1977 Renamed rank to score. 1979 July 28, 1998 Added Dale Lowry as Author 1981 September 4, 1998 Added 422 as response when query lists 1982 unimplemented operators. 1983 DAV:literal declares a default value for xml:space, 'preserve' 1984 (see XML spec, section 2.10) 1985 moved to new XML namespace syntax 1987 September 22, 1998 Changed "simplesearch" to "basicsearch" 1988 Changed isnull to isdefined 1989 Defined NULLness as having a 404 or 403 response 1990 used ENTITY syntax in DTD 1991 Added redirect 1993 October 9, 1998 Fixed a series of typographical and formatting 1994 errors. 1995 Modified the section of three-valued logic to use a table rather 1996 than a text description of the role of UNKNOWN in expressions. 1998 November 2, 1998 Added the DAV:contains operator. 1999 Removed the DAV:contentpassthrough operator. 2001 November 18, 1998 Various author comments for submission 2003 June 3, 1999 Cosmetic and minor editorial changes only. Fix nits 2004 reported by Jim Whitehead in email of April 26, 1999. Converted to 2005 HTML from Word 97, manually. 2007 April 20, 2000 Removed redirection feature, since 301/302 suffices. 2008 Removed Query Schema Discovery (former chapter 4). Everyone agrees 2009 this is a useful feature, but it is apparently too difficult to 2010 define at this time, and it is not essential for DASL. 2012 B.2 since start of draft-reschke-webdav-search 2014 October 09, 2001 Added Julian Reschke as author. 2015 Chapter about QSD re-added. 2016 Formatted into RFC2629-compliant XML document. 2017 Added first comments. 2018 ID version number kicked up to draft-dasl-protocol-03. 2020 October 17, 2001 Updated address information for Jim Davis. 2021 Added issue of datatype vocabularies. 2022 Updated issue descriptions for grammar discovery, added issues on 2023 query schema DTD. 2025 Fixed typos in XML examples. 2027 December 17, 2001 Re-introduced split between normative and 2028 non-normative references. 2030 January 05, 2002 Version bumbed up to 04. Started work on resolving 2031 the issues identified in the previous version. 2033 January 14, 2002 Fixed some XML typos. 2035 January 22, 2002 Closed issues naming-of-elements. Fixed query search 2036 DTD and added option to discover properties of "other" 2037 (non-listed) properties. 2039 January 25, 2002 Changed into private submission and added reference 2040 to historic DASL draft. Marked reference to DASL requirements 2041 non-normative. 2042 Updated reference to latest deltav spec. 2044 January 29, 2002 Added feedback from and updated contact info for 2045 Alan Babich. 2046 Included open issues collected in http://www.webdav.org/dasl/ 2047 protocol/issues.html. 2049 February 8, 2002 Made sure that all artwork fits into 72 characters 2050 wide text. 2052 February 18, 2002 Changed Insufficient storage handling 2053 (multistatus). Moved is-collection to operators and added to DTD. 2054 Made scope/depth mandatory. 2056 February 20, 2002 Updated reference to SQL99. 2058 February 28, 2002 "Non-normative References" -> "Informative 2059 References". Abstract updated. Consistently specify a charset when 2060 using text/xml (no change bars). Do not attempt to define 2061 PROPFIND's entity encoding (take out specific references to text/ 2062 xml). Remove irrelevant headers (Connection:) from examples (no 2063 change bars). Added issue on querying based on DAV:href. Updated 2064 introduction to indicate relationship to DASL draft. Updated HTTP 2065 reference from RFC2068 to RFC2616. Updated XML reference to XML 2066 1.0 2nd edition. 2068 March 1, 2002 Removed superfluous namespace decl in 2.4.2. Reopened 2069 JW14 and suggest to drop xml:space support. 2071 March 3, 2002 Removed "xml:space" feature on DAV:literal. Added issue 2072 about string comparison vs. collations vs. xml:lang. Updated some 2073 of the open issues with details from JimW's original mail in April 2074 1999. Resolved scope vs relative URI references. Resolved issues 2075 about DAV:ascending (added to index) and the BNF for DAV:like 2076 (changed "octets" to "characters"). 2078 March 8, 2002 Updated reference to DeltaV (now RFC3253). Added Martin 2079 Wallmer's comments, moved JW5 into DAV:basicsearch section. 2081 March 11, 2002 Closed open issues regaring the type of search 2082 arbiters (JW3) and their discovery (JW9). Rephrased requirements 2083 on multistatus response bodies (propstat only if properties were 2084 selected, removed requirement for responsedescription). 2086 March 23, 2002 RFC2376 -> RFC3023. Added missing first names of 2087 authors. OPTIONS added to example for DAV:supported-method-set. 2089 B.3 since draft-reschke-webdav-search-00 2091 March 29, 2002 Abstract doesn't refer to DASL WG anymore. 2093 April 7, 2002 Fixed section title (wrong property name 2094 supported-search-grammar-set. Changed DAV:casesensitve to 2095 "casesensitive" (it wasn't in the DAV: namespace after all). 2097 May 28, 2002 Updated some issues with Jim Davis's comments. 2099 June 10, 2002 Added proposal for different method for query schema 2100 discovery, not using pseudo-properties. 2102 June 25, 2002 QSD marshalling rewritten. Added issue 2103 "isdefined-optional". 2105 B.4 since draft-reschke-webdav-search-01 2107 July 04, 2002 Added issue "scope-collection". 2109 July 08, 2002 Closed issue "scope-collection". 2111 August 12, 2002 Added issues "results-vs-binds" and "select-allprop". 2113 October 22, 2002 Added issue "undefined-expressions". 2115 November 18, 2002 Changed example host names (no change tracking). 2117 November 25, 2002 Updated issue "DB2/DB7". Closed issues "undefined 2118 expressions", "isdefined-optional" and "select-allprop". 2120 B.5 since draft-reschke-webdav-search-02 2122 November 27, 2002 Added issues "undefined-properties", 2123 "like-exactlyone" and "like-wildcard-adjacent". Closed issue 2124 "query-on-href". Added acknowledgments section. 2126 November 28, 2002 Closed issue "like-exactlyone". Added issue 2127 "mixed-content-properties". 2129 December 14, 2002 Closed issues "undefined-properties", 2130 "results-vs-binds", "mixed-content-properties". Updated issue 2131 "like-wildcard-adjacent". Added informative reference to BIND 2132 draft. Updated reference to ACL draft. 2134 January 9, 2003 Removed duplicate section on invalid scopes. Added 2135 comments to some open issues. Closed issues JW25/26, 2136 score-pseudo-property and null-ordering. 2138 January 10, 2003 Issue limit-vs-ordering plus resolution. Closed 2139 issue JW17/JW24b. 2141 January 14, 2003 New issue order-precedence. Started resolution of 2142 DB2/DB7. 2144 January 15, 2003 Started spec of DAV:typed-literal. 2146 January 17, 2003 Fix one DAV:like/DAV:getcontenttype example (add / 2147 to like expression, make case-insensitive). 2149 January 28, 2003 Update issue(s) result-truncation, JW24d. Fixed 2150 response headers in OPTIONS example. Added issue qsd-optional. 2151 Closed issue(s) order-precedence, case-insensitivity-name. 2153 February 07, 2003 Added issue scope-vs-versions. 2154 score-pseudo-property: allow DAV:orderby to explicitly specify 2155 DAV:score. 2157 B.6 since draft-reschke-webdav-search-03 2158 April 24, 2003 Fixed two "?" vs "_" issues (not updated in last 2159 draft). 2161 June 13, 2003 Improve index. 2163 B.7 since draft-reschke-webdav-search-04 2165 July 7, 2003 Typo fixed (propstat without status element). 2167 August 11, 2003 Remove superfluous IP and copyright sections. 2169 September 09, 2003 Added issues "2.4-multiple-uris" and 2170 "5.1-name-filtering". 2172 October 06, 2003 Fix misplaced section end in 5.11, add table 2173 formatting. Enhance table formatting in 5.18.3. Updated ACL and 2174 BIND references. Added XPATH reference. Closed issue JW24d by 2175 adding new optional operators. Updated more open issues, added 2176 issues from January meeting. Add K. Wiggen to Acknowledgements. 2177 Add Contributors section for the authors of the original draft. 2178 Close issue "scope-vs-versions" (optional feature added). Close 2179 (new) issue "1.3-import-DTD-terminology". Add issue 2180 "1.3-import-requirements-terminology". 2182 October 07, 2003 Typos fixed. Moved statement about DAV: namespace 2183 usage into separate (sub-)section. Closed 2184 "1.3-import-requirements-terminology". Update I18N Considerations 2185 with new xml:lang support info (see issue JW24d). Close issue 2186 "DB2/DB7" (remaining typing issues are now summarized in issue 2187 "typed-literal"). Fix misplaced section end in section 7. Started 2188 change to use RFC3253-style method definitions and error 2189 marshalling. 2191 October 08, 2003 Remove obsolete language that allowed reporting 2192 invalid scopes and such inside multistatus. Add new issue 2193 "5.4.2-scope-vs-redirects". 2195 B.8 since draft-reschke-webdav-search-05 2197 October 11, 2003 Separate DAV:basicsearch DTD into separate figures 2198 for better maintainability. Update DTD with language-* operators 2199 and typed-literal element (optional). 2201 October 14, 2003 Close issue "5.4.2-multiple-scope". 2203 November 04, 2003 Update reference from CaseMap to UNICODE4, section 2204 5.18. 2206 November 16, 2003 Updated issue "5.1-name-filtering". 2208 November 24, 2003 Reformatted scope description (collection vs. 2209 non-collection). 2211 November 30, 2003 Add issue "5_media_type_match". 2213 February 6, 2004 Updated all references. 2215 Appendix C. Resolved issues (to be removed by RFC Editor before 2216 publication) 2218 Issues that were either rejected or resolved in this version of this 2219 document. 2221 C.1 5.4.2-multiple-scope 2223 Type: change 2225 2228 prakash.yamuna@covigna.com (2003-09-27): (asks for the ability to 2229 specify multiple scopes in a single query) 2231 julian.reschke@greenbytes.de (2003-10-03): Consider making this an 2232 optional extension iff we can come up with a simple enough definition 2233 of it's impact on sorting/ranking and so on. Otherwise propose to 2234 reject. 2236 Resolution (2003-10-14): Allow servers to support multiple scopes in 2237 DAV:basicsearch. Make clear that this is optional. Define 2238 precondition accordingly. 2240 Appendix D. Open issues (to be removed by RFC Editor prior to 2241 publication) 2243 D.1 1.3-apply-condition-code-terminology 2245 Type: change 2247 julian.reschke@greenbytes.de (2003-10-07): (Umbrella issue that will 2248 be left open until RFC3253 condition terminlogy is used throughout 2249 the document) 2251 D.2 2.4-multiple-uris 2253 Type: change 2255 julian.reschke@greenbytes.de (2003-09-09): However, the set of URIs 2256 for a given resource may be unlimited due to possible bind loops. 2257 Therefore consider to report just one URI per resource. 2259 D.3 result-truncation 2261 Type: change 2263 2266 ldusseault@xythos.com (2002-03-29): I believe the same response body 2267 that contains the first N elements should also contain 2268 a *different* element stating that the results were incomplete and 2269 the result set was truncated by the server. There may also be a need 2270 to report that the results were incomplete and the result set was 2271 truncated at the choice of the client (isn't there a limit set in the 2272 client request?) That's important so the client knows the difference 2273 between receiving 10 results because there were >10 but only 10 were 2274 asked for, and receiving 10 results because there were only exactly 2275 10 results and it just happens that 10 were asked for. 2277 jrd3@alum.mit.edu (2002-05-28): I agree that this could be useful, 2278 but I think this issue should be consolidated with issue JW5 (see 2279 below), which proposes that DASL basicsearch ought to have a way for 2280 client to request additional result sets. It should be moved because 2281 there is little or no value in allowing a client to distinguish 2282 between the case where "N results were requested, and there are 2283 exactly N available" and "N results were requested, and there are 2284 more than N available" if there is no way for client to get the next 2285 batch of results. 2287 julian.reschke@greenbytes.de (2003-01-28): Feedback from interim WG 2288 meeting: agreement that marshalling should be rewritten and backwards 2289 compatibility is not important. Proposal: extend DAV:multistatus by a 2290 new child element that indicates (1) the range that was returned, (2) 2291 the total number of results and (3) a URI identifying the result (for 2292 resubmission when getting the "next" results). Such as ...identifier for result set... <-- number of results --> <-- 1-based 2295 index of 1st result --> <-- size of result set 2296 returned --> <-- indicates that this is a 2297 partial result --> ...response elements for search 2298 results... The example below would then translate to: 2299 HTTP/1.1 207 Multistatus Content-Type: text/xml; charset="utf-8" 2300 Content-Length: xxx 2301 2302 http://www.example.net/ 2303 sounds/unbrokenchain.au 2304 HTTP/1.1 200 OK 2305 http://tech.mit.test/archive96/photos/ 2306 Lesh1.jpg HTTP/1.1 200 OK Q: do we need 2308 all elements, in particular start and length? 2310 julian.reschke@greenbytes.de (2003-10-07): Related: if this is 2311 supposed to be normative to DAV:basicsearch, it can't stay in an 2312 "example" sub-section. 2314 D.4 qsd-optional 2316 Type: change 2318 julian.reschke@greenbytes.de (2003-01-28): WG January meeting 2319 feedback: QSD should be made required. 2321 kwiggen@xythos.com (2003-10-03): (significant pushback, see mailing 2322 list thread at http://lists.w3.org/Archives/Public/www-webdav-dasl/ 2323 2003OctDec/0003.html). 2325 D.5 5.1-name-filtering 2327 Type: change 2329 2332 julian.reschke@greenbytes.de (2003-09-08): This query grammar 2333 supports properties and content, but not conditions on URL elements 2334 (such as the last segment that many WebDAV implementations treat as 2335 "file name"). Discuss possible extension such as adding name filters 2336 to the scope, or adding a specific operator. 2338 Martin.Wallmer@softwareag.com (2003-11-11): Specific proposal to add 2339 this feature as scope restriction, see . 2342 Martin.Wallmer@softwareag.com (2003-11-25): Updated proposal: . 2345 D.6 5_media_type_match 2347 Type: change 2349 julian.reschke@greenbytes.de (2003-11-30): Putting conditions on 2350 DAV:getcontenttype is hard (see is (too?) hard. Proposal for a 2352 specific operator for expressing conditions on the media type: 2353 . 2356 D.7 5.4.2-scope-vs-redirects 2358 Type: change 2360 2363 julian.reschke@greenbytes.de (2003-10-08): Clarify the relation of 2364 scope and redirect (3xx) resources. 2366 D.8 language-comparison 2368 Type: change 2370 2373 julian.reschke@greenbytes.de (2002-03-03): XPath/XQuery (see draft, 2374 and open issue) specify string comparisons based on collations, not 2375 languages. I think we should adopt this. This would mean that 2376 "xml:lang" would be removed, and an optional attribute specifying the 2377 name of the collation is added. 2379 julian.reschke@greenbytes.de (2003-01-09): Proposal: adopt "lang" and 2380 "collation" attribute from XSLT 2.0's xsl:sort. 2382 D.9 JW16b/JW24a 2384 Type: change 2386 2389 ejw@ics.uci.edu (2000-04-20): Define how comparisons on strings work, 2390 esp for i18n. Need policy statement about sort order in various 2391 national languages. (JW said "non-Latin" but it's an issue even in 2392 languages that use the latin char set.) 2394 julian.reschke@greenbytes.de (2003-01-28): This issue not only 2395 applies to the comparison operators, but also to ordering! 2397 D.10 typed-literal 2399 Type: change 2401 julian.reschke@greenbytes.de (2003-01-15): 1. (insert language 2402 defining the comparison following the rules defined in http:// 2403 www.w3.org/TR/xpath20/#id-comparisons). 2. Extend Basicsearch QSD 2404 grammar to support discovery of typed-literal 3. Update DTD. 4. 2405 Discuss behaviour of DAV:literal when the property's type is known 2406 for the complete search scope (is the server allowed to be "smart"?) 2408 julian.reschke@greenbytes.de (2003-10-11): 3.: done 2410 Index 2412 C 2413 caseless attribute 28, 35 2414 Condition Names 2415 DAV:search-grammar-discovery-supported (pre) 10 2416 DAV:search-grammar-supported (pre) 10 2417 DAV:search-multiple-scope-supported (pre) 10 2418 DAV:search-scope-valid (pre) 10 2419 Criteria 5 2421 D 2422 DAV:and 28 2423 DAV:ascending 27 2424 DAV:contains 33 2425 DAV:depth 24 2426 DAV:descending 27 2427 DAV:eq 28 2428 caseless attribute 28 2429 DAV:from 24 2430 DAV:gt 29 2431 DAV:gte 29 2432 DAV:include-versions 24 2433 DAV:is-collection 31 2434 DAV:is-defined 32 2435 DAV:language-defined 30 2436 DAV:language-matches 31 2437 DAV:like 32 2438 DAV:limit 35 2439 DAV:literal 29 2440 DAV:lt 29 2441 DAV:lte 29 2442 DAV:not 28 2443 DAV:nresults 35 2444 DAV:or 28 2445 DAV:orderby 27 2446 DAV:scope 24 2447 DAV:score 34 2448 relationship to DAV:orderby 35 2449 DAV:search-grammar-discovery-supported precondition 10 2450 DAV:search-grammar-supported precondition 10 2451 DAV:search-multiple-scope-supported precondition 10 2452 DAV:search-scope-valid precondition 10 2453 DAV:select 24 2454 DAV:supported-query-grammar-set property 16 2455 DAV:typed-literal 29 2456 DAV:where 25 2458 M 2459 Methods 2460 SEARCH 9 2462 O 2463 OPTIONS method 15 2464 DASL response header 15 2466 P 2467 Properties 2468 DAV:supported-query-grammar-set 16 2470 Q 2471 Query Grammar Discovery 15 2472 using live property 16 2473 using OPTIONS 15 2474 Query Grammar 6 2475 Query Schema 6 2476 Query 5 2478 R 2479 Result Record Definition 6 2480 Result Record 6 2481 Result Set Truncation 2482 Example 12 2483 Result Set 6 2484 Result 6 2486 S 2487 Scope 6 2488 SEARCH method 9 2489 Search Modifier 6 2490 Sort Specification 6 2492 Intellectual Property Statement 2494 The IETF takes no position regarding the validity or scope of any 2495 intellectual property or other rights that might be claimed to 2496 pertain to the implementation or use of the technology described in 2497 this document or the extent to which any license under such rights 2498 might or might not be available; neither does it represent that it 2499 has made any effort to identify any such rights. Information on the 2500 IETF's procedures with respect to rights in standards-track and 2501 standards-related documentation can be found in BCP-11. Copies of 2502 claims of rights made available for publication and any assurances of 2503 licenses to be made available, or the result of an attempt made to 2504 obtain a general license or permission for the use of such 2505 proprietary rights by implementors or users of this specification can 2506 be obtained from the IETF Secretariat. 2508 The IETF invites any interested party to bring to its attention any 2509 copyrights, patents or patent applications, or other proprietary 2510 rights which may cover technology that may be required to practice 2511 this standard. Please address the information to the IETF Executive 2512 Director. 2514 Full Copyright Statement 2516 Copyright (C) The Internet Society (2004). All Rights Reserved. 2518 This document and translations of it may be copied and furnished to 2519 others, and derivative works that comment on or otherwise explain it 2520 or assist in its implementation may be prepared, copied, published 2521 and distributed, in whole or in part, without restriction of any 2522 kind, provided that the above copyright notice and this paragraph are 2523 included on all such copies and derivative works. However, this 2524 document itself may not be modified in any way, such as by removing 2525 the copyright notice or references to the Internet Society or other 2526 Internet organizations, except as needed for the purpose of 2527 developing Internet standards in which case the procedures for 2528 copyrights defined in the Internet Standards process must be 2529 followed, or as required to translate it into languages other than 2530 English. 2532 The limited permissions granted above are perpetual and will not be 2533 revoked by the Internet Society or its successors or assignees. 2535 This document and the information contained herein is provided on an 2536 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 2537 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 2538 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 2539 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 2540 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 2542 Acknowledgment 2544 Funding for the RFC Editor function is currently provided by the 2545 Internet Society.