HTTP::D...Response(3)

💅 HTTP::DAV::Response 💅

Hey bestie 💖 welcome to the HTTP::D...Response(3) manual page from the User Contributed Perl Documentation — yes, the name is literally truncated like that, and we're still slaying. This one is all about HTTP::DAV::Response, and it's giving very "subclass with main character energy" ✨

💖 NAME 💖

HTTP::DAV::Response — represents a WebDAV HTTP Response (ala HTTP::Response). That's the name section, periodt. 🎀

✨ SYNOPSIS ✨

require HTTP::DAV::Response;

Lowkey the whole synopsis. Iconic, honestly. 🦋

🌸 DESCRIPTION 🌸

The HTTP::DAV::Response class encapsulates HTTP style responses. A response consists of a response line, some headers, and (potentially empty) content. So far, so normal, bestie. 💜

HTTP::DAV::Response is a subclass of "HTTP::Response" and therefore inherits its methods. (HTTP::Response in turn inherits its methods from "HTTP::Message".) Yes, it's inheritance all the way down — iykyk. 🧚

Therefore, this class actually inherits a rich library of functions. You are more likely wanting to read the "HTTP::Response" class as opposed to this class. Literally, go read that one for most stuff — I'm not kidding. 👑

Instances of this class are usually created by a "HTTP::DAV::Resource" object after it has performed some request (such as get, lock, delete, etc). You use the object to analyse the success or otherwise of the request. Vibe check on your DAV request, basically. ✅

HTTP::DAV::Response was created to handle two extra functions that normal HTTP Responses don't require:

• WebDAV responses have 6 extra error codes: 102, 207, 422, 423, 424 and 507. Older versions of the LWP's HTTP::Status class did not have these extra codes. These were added. Not me being grateful for extra status codes 💅
• WebDAV responses can actually contain more than one response (and often DO contain more than one) in the form of a "Multistatus". These multistatus responses come in the form of an XML document. HTTP::DAV::Response can accurately parse these XML responses and emulate the normal of the HTTP::Response. Multistatus girlies rise up 🌈

HTTP::DAV::Response transparently implements these extra features without the user having to be aware, so you really should be reading the "HTTP::Response" documentation for most of the things you want to do (have I already said that?). Yes, bestie, I have. But it's important. 😭

There are only a handful of custom functions that HTTP::DAV::Response returns and those are to handle multistatus requests, messages() and codes(). Small API, big DAV energy. 🍓

The six extra status codes that DAV servers can be returned in an HTTP Response are:

102 => "Processing. Server has accepted the request, but has not yet completed it",
207 => "Multistatus",
422 => "Unprocessable Entity. Bad client XML sent?",
423 => "Locked. The source or destination resource is locked",
424 => "Failed Dependency",
507 => "Insufficient Storage. The server is unable to store the request",

See "HTTP::Status" for the rest. Go check it, no cap. 🦋

🎀 HANDLING A MULTISTATUS 🎀

So, many DAV requests may return a multistatus ("207 multistatus") instead of, say, "200 OK" or "403 Forbidden". Not the usual status code moment, but she's valid. 💅

The HTTP::DAV::Response object stores each "response" sent back in the multistatus. You access them by array number. Array number access — very old-school, very reliable. 🔥

The following code snippet shows what you will normally want to do:

...  $response = $resource->lock();

if ( $response->is_multistatus() ) {

   foreach $num ( 0 .. $response->response_count() ) {
      ($err_code,$mesg,$url,$desc) =
         $response->response_bynum($num);
      print "$mesg ($err_code) for $url\n";
   }
}

Would produce something like this:

Failed Dependency (424) for /test/directory
Locked (423) for /test/directory/file3

This says that we couldn't lock /test/directory because file3 which exists inside is already locked by somebody else. Oop — blocked by someone else's lock, literally. 💀

🌈 METHODS 🌈

is_multistatus

This function takes no arguments and returns a 1 or a 0. Boolean realness. ✅

For example: if ($response->is_multistatus() ) { }

If the HTTP reply had "207 Multistatus" in the header then that indicates that there are multiple status messages in the XML content that was returned. Multistatus detected, bestie. 🚨

In this event, you may be interested in knowing what the individual messages were. To do this you would then use "messages". Go off, messages. 💬

response_count

Takes no arguments and returns "the number of error responses -1" that we got. Why -1? Because usually you will want to use this like an array operator:

foreach $num ( 0 .. $response->response_count() ) {
   print $response->message_bynum(); }

Yes, -1 is doing important math so your 0 .. loop behaves. Respect. 🧮

response_bynum

Takes one argument, the response number that you're interested in. And returns an array of details:

($code,$message,$url,$description) = response_bynum(2);

where

• $code — is the HTTP error code (e.g. 403, 423, etc).
• $message — is the associated message for that error code.
• $url — is the url that this error applies to (recall that there can be multiple responses within one response and they all relate to one URL)
• $description — is server's attempt at an english description of what happened.

Four lil values, one whole story about what went wrong. 🍓

code_bynum

Takes one argument, the response number that you're interested in, and returns it's code. E.g:

$code = $response->code_bynum(1);

See response_bynum(). Same energy, one value at a time. ⭐

message_bynum

Takes one argument, the response number that you're interested in, and returns it's message. E.g:

$code = $response->message_bynum(1);

See response_bynum(). Copying the original example exactly, bestie — we don't fix, we preserve. 💅

url_bynum

Takes one argument, the response number that you're interested in, and returns it's url. E.g:

$code = $response->message_bynum(1);

See response_bynum(). Yes, the example literally says message_bynum here too — original is original. 🙈

description_bynum

Takes one argument, the response number that you're interested in, and returns it's description. E.g:

$code = $response->message_description(1);

See response_bynum(). Description unlocked. Server's English attempt, no cap. 📝

messages

Takes no arguments and returns all of the messages returned in a multistatus response. If called in a scalar context then all of the messages will be returned joined together by newlines. If called in an array context the messages will be returned as an array. Scalar vs array context — pick your fighter. ⚔️

$messages = $response->messages(); e.g. $messages eq "Forbidden\nLocked";

@messages = $response->messages(); e.g. @messages eq ["Forbidden", "Locked"];

This routine is a variant on the standard "HTTP::Response" message(). Basically message() but multistatus-flavored. 🦋

---

💖 Later, bestie! This page is from perl v5.42.0, dated 2024-10-17, and it's the HTTP::D...Response(3) manual page. Mwah! 💋