Image

head

code

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

unit class IO::Path::ChildSecure:ver<1.1>:auth<zef:raku-community-modules>;

# The goal of this method is to guarantee the resultant child path is
# inside the invocant. We resolve the path completely, so for that to
# happen, the kid cannot be inside some currently non-existent dirs, so
# this method will fail with X::IO::Resolve in those cases. To find out
# if the kid is in fact a kid, we fully-resolve the kid and the
# invocant. Then, we append a dir separator to invocant's .absolute and
# check if the kid's .absolute starts with that string.

my sub child-secure (IO::Path:D \SELF, \child) is export {
    (my $kid := SELF.child(child).resolve: :completely) ~~ Failure
      ?? $kid
      !! (my $res-self := SELF.resolve: :completely) ~~ Failure
        ?? $res-self  # failed to resolve invocant, return the Failure
        !! ($_ := $res-self.absolute ~ SELF.SPEC.dir-sep) eq
            $kid.absolute.substr(0, .chars)
          ?? $kid     # kid appears to be kid-proper; return it. Otherwise fail
          !! Failure.new:
               X::IO::NotAChild.new:
                 :path($res-self.absolute), :child($kid.absolute)
}



IO::Path::ChildSecure - Secure version of IO::Path.child


=begin code :lang<raku>

use IO::Path::ChildSecure;

# good; you get IO::Path
"foo".IO.&child-secure: 'meow';

# still good if 'foo/meow/foo/bar/../' exists; Failure if it doesn't
"foo".IO.&child-secure: 'meow/foo/bar/../meow';

# bad; path isn't a child; you get Failure
"foo".IO.&child-secure: '../';

=end code


In the Raku Programming Language,
L<IO::Path.child|https://docs.raku.org/type/IO::Path#method_child> isn't
secure, in a sense that it does no checks for whether the resultant path is
actually a child of the original path.


This module provides a subroutine that can be used as an alternative that
B<will> check whether the resultant path is a child of the original path.


=begin code :lang<raku>

"foo".IO.&child-secure: 'meow'; # good; you get IO::Path
"foo".IO.&child-secure: 'meow/foo/bar/../meow'; # still good
"foo".IO.&child-secure: '../';  # bad; path isn't a child; you get Failure

child-secure "foo".IO, '../';  # can also use as a proper sub

=end code


Appends the given path chunk to the invocant and ensures the resultant path
is, in fact, a child of the invocant, by accessing the filesystem and
fully-resolving the path. The last chunk of the resultant path does not have
to exist for the resolution to succeed.


Will L<fail|https://docs.raku.org/routine/fail> with C<X::IO::Resolve> if
failed to fully resolve the resultant path or with C<X::IO::NotAChild> if
the resultant path is not a child of the invocant.


If you don't need to ensure secureness, use the much-faster core
  L<C<IO::Path.add> method|https://docs.raku.org/type/IO::Path#method_add>


This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.


ChildSecure

class IO::Path::AutoDecompress is IO::Path {
    method lines(
      :$chomp = True,
      :$enc   = 'utf8',
      :$nl-in = ["\x0A", "\r\n"]
    ) {
        my str $extension = self.extension;
        if $extension eq 'gz' {
            my $proc := run <gunzip --stdout>, self, :out;
            $proc.out.lines(:$chomp, :$enc, :$nl-in)
        }
        elsif $extension eq 'bz2' {
            my $proc := run <bunzip2 --stdout>, self, :out;
            $proc.out.lines(:$chomp, :$enc, :$nl-in)
        }
        else {
            self.IO::Path::lines(:$chomp, :$enc, :$nl-in)
        }
    }

    method slurp(:$enc = 'utf8') {
        my str $extension = self.extension;
        if $extension eq 'gz' {
            my $proc := run <gunzip --stdout>, self, :out;
            $proc.out.slurp(:$enc)
        }
        elsif $extension eq 'bz2' {
            my $proc := run <bunzip2 --stdout>, self, :out;
            $proc.out.slurp(:$enc)
        }
        else {
            self.IO::Path::slurp(:$enc)
        }
    }
}



IO::Path::AutoDecompress - IO::Path with automatic decompression


=begin code :lang<raku>

use IO::Path::AutoDecompress;

=end code


IO::Path::AutoDecompress is a module that provides a subclass to
C<IO::Path>, that will transparently handle compressed files that
are compressed with C<gzip> (the C<.gz> file extension) or C<bzip2>
(the C<.bz2> extension) for the C<.slurp> and C<.lines> methods.


This module assumes some version of the C<gunzip> and C<bunzip2>
programs can be executed with the C<--stdout> argument.


Source can be located at: https://github.com/lizmat/IO-Path-AutoDecompress .
Comments and Pull Requests are welcome.


If you like this module, or what I’m doing more generally, committing to a
L<small sponsorship|https://github.com/sponsors/lizmat/>  would mean a great
deal to me!


AutoDecompress

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


README

NAME

SYNOPSIS

DESCRIPTION

PREREQUISITES

AUTHOR

COPYRIGHT AND LICENSE

IO::Path::AutoDecompress v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation