/usr/share/perl5/POE/Component/Client/MPD/Collection.pm is in libpoe-component-client-mpd-perl 2.000-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | #
# This file is part of POE-Component-Client-MPD
#
# This software is copyright (c) 2007 by Jerome Quelin.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.010;
use strict;
use warnings;
package POE::Component::Client::MPD::Collection;
# ABSTRACT: module handling collection commands
$POE::Component::Client::MPD::Collection::VERSION = '2.000';
use Moose;
use MooseX::Has::Sugar;
use POE;
use POE::Component::Client::MPD::Message;
has mpd => ( ro, required, weak_ref, );# isa=>'POE::Component::Client::MPD' );
# -- Collection: retrieving songs & directories
sub _do_all_items {
my ($self, $msg) = @_;
my $path = $msg->params->[0] // ''; # FIXME: padre//
$msg->_set_commands ( [ qq{listallinfo "$path"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_all_items_simple {
my ($self, $msg) = @_;
my $path = $msg->params->[0] // ''; # FIXME: padre//
$msg->_set_commands ( [ qq{listall "$path"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_items_in_dir {
my ($self, $msg) = @_;
my $path = $msg->params->[0] // ''; # FIXME: padre//
$msg->_set_commands ( [ qq{lsinfo "$path"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
# -- Collection: retrieving the whole collection
# event: coll.all_songs()
# FIXME?
sub _do_all_albums {
my ($self, $msg) = @_;
$msg->_set_commands ( [ 'list album' ] );
$msg->_set_cooking ( 'strip_first' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_all_artists {
my ($self, $msg) = @_;
$msg->_set_commands ( [ 'list artist' ] );
$msg->_set_cooking ( 'strip_first' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_all_titles {
my ($self, $msg) = @_;
$msg->_set_commands ( [ 'list title' ] );
$msg->_set_cooking ( 'strip_first' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_all_files {
my ($self, $msg) = @_;
$msg->_set_commands ( [ 'list filename' ] );
$msg->_set_cooking ( 'strip_first' );
$self->mpd->_send_to_mpd( $msg );
}
# -- Collection: picking songs
sub _do_song {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{find filename "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$msg->_set_transform( 'as_scalar' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_with_filename_partial {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{search filename "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
# -- Collection: songs, albums & artists relations
sub _do_albums_by_artist {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{list album "$what"} ] );
$msg->_set_cooking ( 'strip_first' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_by_artist {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{find artist "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_by_artist_partial {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{search artist "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_from_album {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{find album "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_from_album_partial {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{search album "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_with_title {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{find title "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
sub _do_songs_with_title_partial {
my ($self, $msg) = @_;
my $what = $msg->params->[0];
$msg->_set_commands ( [ qq{search title "$what"} ] );
$msg->_set_cooking ( 'as_items' );
$self->mpd->_send_to_mpd( $msg );
}
no Moose;
__PACKAGE__->meta->make_immutable;
1;
__END__
=pod
=head1 NAME
POE::Component::Client::MPD::Collection - module handling collection commands
=head1 VERSION
version 2.000
=head1 DESCRIPTION
L<POE::Component::Client::MPD::Collection> is responsible for handling
general purpose commands. They are in a dedicated module to achieve
easier code maintenance.
To achieve those commands, send the corresponding event to the
L<POE::Component::Client::MPD> session you created: it will be
responsible for dispatching the event where it is needed. Under no
circumstance should you call directly subs or methods from this
module directly.
Read L<POE::Component::Client::MPD>'s pod to learn how to deal with
answers from those commands.
Following is a list of collection-related events accepted by POCOCM.
=head1 RETRIEVING SONGS & DIRECTORIES
=head2 coll.all_items( [$path] )
Return all L<Audio::MPD::Common::Item>s (both songs & directories)
currently known by mpd.
If C<$path> is supplied (relative to mpd root), restrict the retrieval to
songs and dirs in this directory.
=head2 coll.all_items_simple( [$path] )
Return all L<Audio::MPD::Common::Item>s (both songs & directories)
currently known by mpd.
If C<$path> is supplied (relative to mpd root), restrict the retrieval
to songs and dirs in this directory.
B</!\ Warning>: the L<Audio::MPD::Common::Item::Song> objects will only
have their attribute file filled. Any other attribute will be empty, so
don't use this sub for any other thing than a quick scan!
=head2 coll.items_in_dir( [$path] )
Return the items in the given C<$path>. If no C<$path> supplied, do it on mpd's
root directory.
Note that this sub does not work recusrively on all directories.
=head1 RETRIEVING THE WHOLE COLLECTION
=head2 coll.all_albums( )
Return the list of all albums (strings) currently known by mpd.
=head2 coll.all_artists( )
Return the list of all artists (strings) currently known by mpd.
=head2 coll.all_titles( )
Return the list of all titles (strings) currently known by mpd.
=head2 coll.all_files( )
Return a mpd_result event with the list of all filenames (strings)
currently known by mpd.
=head1 PICKING A SONG
=head2 coll.song( $path )
Return the L<Audio::MPD::Common::Item::Song> which correspond to
C<$path>.
=head2 coll.songs_with_filename_partial( $string )
Return the L<Audio::MPD::Common::Item::Song>s containing C<$string> in
their path.
=head1 SONGS, ALBUMS & ARTISTS RELATIONS
=head2 coll.albums_by_artist( $artist )
Return all albums (strings) performed by C<$artist> or where C<$artist>
participated.
=head2 coll.songs_by_artist( $artist )
Return all L<Audio::MPD::Common::Item::Song>s performed by C<$artist>.
=head2 coll.songs_by_artist_partial( $artist )
Return all L<Audio::MPD::Common::Item::Song>s performed by C<$artist>.
=head2 coll.songs_from_album( $album )
Return all L<Audio::MPD::Common::Item::Song>s appearing in C<$album>.
=head2 coll.songs_from_album_partial( $string )
Return all L<Audio::MPD::Common::Item::Song>s appearing in album
containing C<$string>.
=head2 coll.songs_with_title( $title )
Return all L<Audio::MPD::Common::Item::Song>s which title is exactly
C<$title>.
=head2 coll.songs_with_title_partial( $string )
Return all L<Audio::MPD::Common::Item::Song>s where C<$string> is part
of the title.
=head1 AUTHOR
Jerome Quelin
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2007 by Jerome Quelin.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|