Panda::URI - fast URI.pm-like framework written in C, with Perl and C interface
Panda::URI has similar functionality as URI.pm, but is much faster (sometimes 100x). It is used as a base URI unit in all Panda::* modules.
use Panda::URI qw/uri :const/; my $u = Panda::URI->new("http://mysite.com:8080/my/path?a=b&c=d#myhash"); say $u->scheme; say $u->host; say $u->port; say $u->path; say $u->query_string; Dumper($u->query); say $u->fragment; $u = Panda::URI->new("about:blank"); say $u->scheme; say $u->path; $u->clone;
Creates URI object from string $url. Created object will be of special subclass (Panda::URI::http, Panda::URI::ftp, ...) if scheme is supported. Otherwise it will be of class Panda::URI.
Created object is in "strict" mode, i.e. it has additional methods according to the scheme, however you cannot change it's scheme. You can still set a new url to this objects, but it must have the same scheme or error will be raisen.
Also "strict"(customized) classes has its own constructors with possibly additional arguments like this:
my $url = Panda::URI::http->new("http://google.com?b=20", q => 'something', a => 10); say $url->query_string; # q=something&a=10&b=20 $url->scheme('ftp'); # CROAKS, changing scheme is disallowed.
See custom classes' docs for details.
$flags is a bitmask of one or more of these:
By default, RFC doesn't allow urls to begin with authority (i.e. host,port). For example
www.google.com/hello
is not interpreted as you might think. In this case, url is treated as relative and "www.google.com/hello" is a path
Enabling this flag makes Panda::URI detect such urls:
www.google.com/hello no scheme, host is www.google.com, path is /hello hello/world no scheme, host is hello, path is world /hello/world no scheme, no host, path is /hello/world
However, Panda::URI never produces RFC-uncompliant urls on output, so
say uri("www.google.com/hello", ALLOW_LEADING_AUTHORITY);
prints "//www.google.com/hello" (scheme-relative format), making it valid
If true, Panda::URI will use ';' as delimiter between query string params instead of a default '&'. Both for input and output.
Registers a new scheme and a perl class for that scheme (it must inherit from Panda::URI). This only applies when creating "strict"(customized) urls via uri() function (or via custom class' constructor).
As Panda::URI is a C++ framework in its base, you want also register a C++ class for that scheme in XS to be able to do something when such uris are constructed (even from XS/C code).
See REGISTERING SCHEMAS for how to.
REGISTERING SCHEMAS
Does what JavaScript's encodeURIComponent does.
$uri = encode_uri_component("http://www.example.com/"); # http%3A%2F%2Fwww.example.com%2F
If $use_plus is true, then produces '+' for spaces instead of '%20'.
Does what JavaScript's decodeURIComponent does.
$str = decode_uri_component("http%3A%2F%2Fwww.example.com%2F"); # http://www.example.com/
Creates URI object from string $url. Created object will be "non-strict", i.e. it will be of class "Panda::URI" and won't have any scheme-specific methods, however you can change its scheme and set new urls with defferent scheme into the object.
register_scheme() makes no effect for this method.
$flags are the same as for uri() function.
Returns url as string. If $newurl is present, sets this url in object (respecting $flags). May croak if object is in "strict" mode and $newurl's scheme differs from current. If object is "strict" and $newurl has no scheme, it's assumed to be current (instead of leaving it empty if object is non-strict). Examples:
my $u = Panda::URI->new("http://facebook.com"); # non-strict mode $u->query({a => 1, b => 2}); say $u->url; # http://facebook.com?a=1&b=2 $u->url("//twitter.com"); # scheme-relative url say $u; # //twitter.com $u = uri("http://facebook.com"); # strict mode $u->url("//twitter.com"); say $u; # http://twitter.com, force object's scheme as it cannot change $u->url("svn://svn.com"); # croaks, scheme cannot change $u = Panda::URI::ftp->new("//my.com"); # strict mdoe say $u; # ftp://my.com $u->url("http://ya.ru"); # croaks
Sets/returns uri's scheme. May croak if object is strict and new scheme differs from current.
Sets/returns user_info part of uri (ftp://<user_info>@host/...)
Sets/returns host part of uri
Sets/returns port. If no port is explicitly present in uri, returns default port for uri's scheme. If no scheme in uri, returns 0.
Returns port if it was explicitly set via port() or was present in uri. Otherwise returns 0.
Returns default port for the uri's scheme. Returns 0 if scheme is not specified/not supported.
Sets/returns path part of uri as string.
Sets/returns query string part of uri as string. String is expected/returned in decoded, but plain format, i.e. after uri encode of all params, but before encode_uri_component of the whole result string.
Sets/returns query string part of uri as string. String is expected/returned in RAW (encoded) format, i.e. after uri encode of all params and after encode_uri_component of the whole result string.
If no params specified, returns query part of uri as hashref. Keys/values are returned unencoded. If uri has no query params, empty hash is returned.
If you change returned hash, no changes will occur in uri object. To commit these changes, set this hash again via query($hash) or use param() method.
If params are specified, sets new query from hash or hashref or string. Keys/values are accepted unencoded for hash/hashref.
If you pass query as string, the effect will be the same as calling query_string($new_query).
If you want to make query strings like 'a=1&a=2&a=3', set "a"'s value to an arrayref of values, like:
$u = Panda::URI->new("http://ya.ru"); $u->query(b => 10, a => [1,2,3]); say $u; # http://ya.ru?b=10&a=1&a=2&a=3
Note hovewer, that multiparams are NOT returned in hashref:
say Dumper($u->query); # {b => 10, a => 1/2/3 }
A's value may be any of 1/2/3 depending on hash order. This is done because most of the time you don't want multiparams and don't wanna be suprised by an arrayref in query if someone passes you second value for some key.
If you want to get all values of multiparam, use multiparam().
Like query() but instead of replacing, adds passed query to existing query. If some key already exists in uri's query, it doesn't get replaced, instead it becomes a multiparam.
Without second arg, returns the value of query param '$name'. If no such param exists, return undef. If param $name is a multiparam, returns one of its values.
With $value supplied, replaces current value(values) of $name with $value.
With \@values supplied, replaces current value(values) of $name with \@values ($name becomes multiparam).
Does the same as param() does. The only difference is when called without second arg, returns a list of param's values if param is a multiparam. Also returns empty list instead of undef if there is no such param in query.
Returns the number of query parameters in query (even for multiparams). For example:
"http://google.com"; # nparam() == 0 "http://google.com?a=1&b=2"; # nparam() == 2 "http://google.com?a=1&b=2&b=3&b=4"; # nparam() == 4
Removes param $name from query. If param is a multiparam, removes all its values.
Sets/returns fragment (hash) part of uri.
Sets/returns location part of uri. Location is a "host:port" together. If no port was explicitly set, returned location will contain details port for the scheme. If no scheme defined, or scheme is unknown, returned location will contain port 0 - "host:0". Examples:
say Panda::URI->new("http://ya.ru:8080")->location; # ya.ru:8080 say Panda::URI->new("http://ya.ru")->location; # ya.ru:80 say Panda::URI->new("//ya.ru")->location; # ya.ru:0 say Panda::URI->new("http://ya.ru")->explicit_location; # ya.ru say Panda::URI->new("http://ya.ru:8080")->explicit_location; # ya.ru:8080
Returns location with explicit port set if any, otherwise returns location without port (i.e. just host).
Effect is the same as
$u->explicit_port ? $u->host.':'.$u->port : $u->host
Returns uri, relative to current scheme and location, for example:
say uri("http://ya.ru/mypath")->relative; # /mypath
Returns the whole uri as string.
Returns true if url is not empty. Note that if an uri object has only user_info or only port set, it is empty as it is not printable.
Actually
if ($uri) {} # the same as if ($uri->to_bool())
is the same as
if ($uri->to_string) {}
but runs faster.
Returns true if uri's scheme is secure (for example, https).
Sets uri from another uri object making them equal. May croak if current object is strict and other object has different scheme.
Same as url($url, [$flags])
Returns true if $other_uri contains the same url (including all parts - query, fragment, etc).
Clones current uri. If current uri is in strict mode, then cloned uri will be in strict mode too.
Sets/returns path segments as list.
$u = uri("http://ya.ru/abc/def/jopa"); say join(", ", $u->path_segments); # abc, def, jopa $u->path_segments('my', 'folder'); say $u; # http://ya.ru/my/folder
If provided, adds query params to $url after creating object.
Sets/returns user part of user_info in uri.
Sets/returns password part of user_info in uri.
Panda::URI supports:
clone
convert_blessed
Here and below only short details are explained. For full docs see perl interface docs above. All functions and classes are in panda::uri:: namespace.
string is not an std::string, it's a panda::string, which has the same API, but is more effective and supports Copy-On-Write regardless of your compiler version. See Panda::Lib for details.
string
Creates uri object in strict mode. Returns object of customized class (panda::uri::URI::http, ...). If no scheme specified or scheme is not supported, returns object of a default class panda::uri::URI.
Creates strict uri object from another uri object.
Creates empty non-strict uri object.
Creates non-strict uri object from string.
Creates non-strict uri object from another object (cloning).
Sets data from another uri object or url string.
Returns properties of uri.
Assign data from another uri. Same as URI& operator= (const URI& source).
URI& operator= (const URI& source)
Assign data from url string.
Returns unencoded query string
Returns encoded query string
Returns query params as object of class Query (std::multimap<string,string>). Unlike for perl's method, you can change this multimap object and changes will take effect for uri object.
Same as previous method but only for reading.
Changes object's scheme. May throw an exception of class WrongScheme if object in strict mode and schemes differ.
Changes properties of uri.
Sets unencoded query string
Sets encoded query string
Same as query_string(qstr).
Replaces current query with new one supplied as multimap.
Adds query params from addstr to current query.
Adds query params from addquery to current query.
Returns value for param with key 'key'. If it's a multiparam, returns first of its values.
Sets param value replacing existing one. If it's a multiparam, replaces just first of its values.
It is an iterator for string or string_view
It
See perl interface docs for methods above.
Swaps content of two uri objects.
Creator function type for custom scheme objects.
Registers new scheme. "ti" is a typeinfo for your scheme's class. It's required for URI framework to automatically convert scheme names to classes and vice-versa.
'dest' must have enough space to hold the result (in worst case = srclen*3 + 1)). Returns the actual resulting string length.
'unsafe' is an array char[256] where index is char code to be replaced and value is either 0 or the same char code. If value is 0 then this char should be replaced with %XX. If value isn't 0, then it is replaced with value code. By default the alphabet for query param names and values is used. You can use one of these predefined arrays (in panda::uri::): unsafe_scheme, unsafe_uinfo, unsafe_host, unsafe_path, unsafe_path_segment, unsafe_query, unsafe_query_component, unsafe_fragment.
String versions.
'dest' must have enough space to hold the result (in worst case = srclen)). Returns the actual resulting string length.
Let's create our custom scheme "myproto" which like FTP uses some info from "user_info". Our protocol won't be secure and default port is for example 12345.
Firstly we need to create our own C++ class. It must inherit from panda::uri::URI::Strict
#include <panda/uri.h> using panda::uri::URI; class URI::myproto : public Strict { public: myproto () : Strict() {} myproto (const string& source, int flags = 0) : Strict(source, flags) { strict_scheme(); } myproto (const URI& source) : Strict(source) { strict_scheme(); } using Strict::operator=; const string some_data_from_user_info () const { // parse user_info // return result } void some_data_from_user_info (const string& new_data) { // change user_info }
Notice the strict_scheme() call in constructor. It is required because it will throw an exception if scheme is wrong. In all other methods it is done automatically, but unfortunately while in panda::uri::URI::Strict class constructor, object is not yet ready for type_info manipulations.
Secondly, create a function that creates URI::myproto object from default URI object.
static URI* new_myproto (const URI& source) { return new URI::myproto(source); }
Now, register your new scheme somewhere in program's initialization:
void init () { ... URI::register_scheme("myproto", &typeid(URI::myproto), new_myproto, 12345, false); }
That's it. Now use your custom scheme:
URI* uri = URI::create("myproto://myinfo@google.com"); URI::myproto myuri = dynamic_cast<URI::myproto*>(uri); // will return not-null cout << myuri->some_data_from_user_info(); };
Finally, create an XS and register a perl class
# TYPEMAP URI::myproto* XT_PANDA_URI_STRICT # XS #include <xs/uri.h> MODULE = MyURI PACKAGE = MyURI::myproto PROTOTYPES: DISABLE string URI::myproto::some_data_from_user_info (SV* newval = NULL) { if (newval) { THIS->some_data_from_user_info(sv2string(newval)); XSRETURN_UNDEF; } RETVAL = THIS->some_data_from_user_info(); } ... # Somewhere in perl Panda::URI::register_scheme("myproto", "MyURI::myproto");
Usage from perl:
my $u = uri("myproto://info@google.com"); say ref $u; # MyURI::myproto say $u->some_data_from_user_info;
Typemap for input/output any URI objects.
Typemaps for input/output strict uris.
Output-only typemap for autodetecting strict uri type and setting right perl class to bless to. You must not define a 'CLASS' variable.
# XS URI* my_cool_uri_create1 (string url) { const char* CLASS = "Panda::URI"; RETVAL = URI::create(url); } URIx* my_cool_uri_create2 (string url) { RETVAL = URI::create(url); } # Perl say ref my_cool_uri_create1("http://ya.ru"); # Panda::URI say ref my_cool_uri_create1("ftp://ya.ru"); # Panda::URI say ref my_cool_uri_create2("http://ya.ru"); # Panda::URI::http say ref my_cool_uri_create2("ftp://ya.ru"); # Panda::URI::ftp
Typemap to inherit from for your custom typemap classes for non-strict uris.
Typemap to inherit from for your custom typemap classes for strict uris. The difference is that this typemap class will automatically set CLASS variable to the right perl class to bless to.
Pronin Oleg <syber@crazypanda.ru>, Crazy Panda, CP Decision LTD
You may distribute this code under the same terms as Perl itself.
To install Panda::URI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Panda::URI
CPAN shell
perl -MCPAN -e shell install Panda::URI
For more information on module installation, please visit the detailed CPAN module installation guide.