-
Notifications
You must be signed in to change notification settings - Fork 2
/
Query.pm
1400 lines (1042 loc) · 45.1 KB
/
Query.pm
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
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
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package HTML::Query;
our $VERSION = '0.07';
use Badger::Class
version => $VERSION,
debug => 0,
base => 'Badger::Base',
utils => 'blessed',
import => 'class CLASS',
vars => 'AUTOLOAD',
constants => 'ARRAY',
constant => {
ELEMENT => 'HTML::Element',
BUILDER => 'HTML::TreeBuilder',
},
exports => {
any => 'Query',
hooks => {
query => \&_export_query_to_element,
},
},
messages => {
no_elements => 'No elements specified to query',
no_query => 'No query specified',
no_source => 'No argument specified for source: %s',
bad_element => 'Invalid element specified: %s',
bad_source => 'Invalid source specified: %s',
bad_query => 'Invalid query specified: %s',
bad_spec => 'Invalid specification "%s" in query: %s',
is_empty => 'The query does not contain any elements',
};
our $SOURCES = {
text => sub {
class(BUILDER)->load;
BUILDER->new_from_content(shift);
},
file => sub {
class(BUILDER)->load;
BUILDER->new_from_file(shift);
},
tree => sub {
$_[0]
},
query => sub {
ref $_[0] eq ARRAY
? @{ $_[0] }
: $_[0];
},
};
sub Query (@) {
CLASS->new(@_);
}
sub new {
my $class = shift;
my ($element, @elements, $type, $code, $select);
# expand a single list ref into items
unshift @_, @{ shift @_ }
if @_ == 1 && ref $_[0] eq ARRAY;
$class = ref $class || $class;
my $self = {
error => undef,
suppress_errors => undef,
match_self => undef,
elements => \@elements,
specificity => {}
};
# each element should be an HTML::Element object, although we might
# want to subclass this module to recognise a different kind of object,
# so we get the element class from the ELEMENT constant method which a
# subclass can re-define.
my $element_class = $class->ELEMENT;
while (@_) {
$element = shift;
$class->debug("argument: ".$element) if DEBUG;
if (! ref $element) {
# a non-reference item is a source type (text, file, tree)
# followed by the source, or if it's the last argument following
# one ore more element options or named argument pairs then it's
# a selection query
if (@_) {
$type = $element;
$code = $SOURCES->{ $type }
|| return $class->error_msg( bad_source => $type );
$element = shift;
$class->debug("source $type: $element") if DEBUG;
unshift(@_, $code->($element));
next;
}
elsif (@elements) {
$select = $element;
last;
}
}
elsif (blessed $element) {
# otherwise it should be an HTML::Element object or another
# HTML::Query object
if ($element->isa($element_class)) {
push(@elements, $element);
next;
}
elsif ($element->isa($class)) {
push(@elements, @{$element->get_elements});
next;
}
}
return $class->error_msg( bad_element => $element );
}
bless $self, $class;
return defined $select ? $self->query($select) : $self;
}
sub query {
my ($self, $query) = @_;
my @result;
my $ops = 0;
my $pos = 0;
$self->{error} = undef;
return $self->error_msg('no_query')
unless defined $query && length $query;
# multiple specs can be comma separated, e.g. "table tr td, li a, div.foo"
COMMA: while (1) {
# each comma-separated traversal spec is applied downward from
# the source elements in the $self->{elements} query
my @elements = @{$self->get_elements};
my $comops = 0;
my $specificity = 0;
my $startpos = pos($query) || 0;
my $hack_sequence = 0; # look for '* html'
warn "Starting new COMMA" if DEBUG;
# for each whitespace delimited descendant spec we grok the correct
# parameters for look_down() and apply them to each source element
# e.g. "table tr td"
SEQUENCE: while (1) {
my @args;
$pos = pos($query) || 0;
my $relationship = '';
my $leading_whitespace;
warn "Starting new SEQUENCE" if DEBUG;
# ignore any leading whitespace
if ($query =~ / \G (\s+) /cgsx) {
$leading_whitespace = defined($1) ? 1 : 0;
warn "removing leading whitespace\n" if DEBUG;
}
# grandchild selector is whitespace sensitive, requires leading whitespace
if ($leading_whitespace && $comops && ($query =~ / \G (\*) \s+ /cgx)) {
# can't have a relationship modifier as the first part of the query
$relationship = $1;
warn "relationship = $relationship\n" if DEBUG;
}
# get other relationship modifiers
if ($query =~ / \G (>|\+) \s* /cgx) {
# can't have a relationship modifier as the first part of the query
$relationship = $1;
warn "relationship = $relationship\n" if DEBUG;
if (!$comops) {
return $self->_report_error( $self->message( bad_spec => $relationship, $query ) );
}
}
# optional leading word is a tag name
if ($query =~ / \G ([\w\*]+) /cgx) {
my $tag = $1;
if ($tag =~ m/\*/) {
if (($leading_whitespace || $comops == 0) && ($tag eq '*')) {
warn "universal tag\n" if DEBUG;
push(@args, _tag => qr/\w+/);
if ($comops == 0) { #we need to catch the case where we see '* html'
$hack_sequence++;
}
}
else {
return $self->_report_error( $self->message( bad_spec => $tag, $query ) );
}
}
else {
warn "html tag\n" if DEBUG;
$specificity += 1; # standard tags are worth 1 point
push( @args, _tag => $tag );
if ($comops == 1 && $tag eq 'html') {
$hack_sequence++;
}
}
}
# loop to collect a description about this specific part of the rule
while (1) {
my $work = scalar @args;
# that can be followed by (or the query can start with) a #id
if ($query =~ / \G \# ([\w\-]+) /cgx) {
$specificity += 100;
push( @args, id => $1 );
}
# and/or a .class
if ($query =~ / \G \. ([\w\-]+) /cgx) {
$specificity += 10;
push( @args, class => qr/ (^|\s+) $1 ($|\s+) /x );
}
# and/or none or more [ ] attribute specs
if ($query =~ / \G \[ (.*?) \] /cgx) {
my $attribute = $1;
$specificity += 10;
#if we have an operator
if ($attribute =~ m/(.*?)\s*([\|\~]?=)\s*(.*)/) {
my ($name,$attribute_op,$value) = ($1,$2,$3);
unless (defined($name) && length($name)) {
return $self->_report_error( $self->message( bad_spec => $name, $query ) );
}
warn "operator $attribute_op" if DEBUG;
if (defined $value) {
for ($value) {
s/^['"]//;
s/['"]$//;
}
if ($attribute_op eq '=') {
push( @args, $name => $value);
}
elsif ($attribute_op eq '|=') {
push(@args, $name => qr/\b${value}-?/)
}
elsif ($attribute_op eq '~=') {
push(@args, $name => qr/\b${value}\b/)
}
else {
return $self->_report_error( $self->message( bad_spec => $attribute_op, $query ) );
}
}
else {
return $self->_report_error( $self->message( bad_spec => $attribute_op, $query ) );
}
}
else {
unless (defined($attribute) && length($attribute)) {
return $self->_report_error( $self->message( bad_spec => $attribute, $query ) );
}
# add a regex to match anything (or nothing)
push( @args, $attribute => qr/.*/ );
}
}
# and/or one or more pseudo-classes
if ($query =~ / \G : ([\w\-]+) /cgx) {
my $pseudoclass = $1;
$specificity += 10;
if ($pseudoclass eq 'first-child') {
push( @args, sub { ! grep { ref $_ } $_[0]->left() } );
} elsif ($pseudoclass eq 'last-child') {
push( @args, sub { ! grep { ref $_ } $_[0]->right() } );
} else {
warn "Pseudoclass :$pseudoclass not supported";
next;
}
}
# keep going until this particular expression is fully processed
last unless scalar(@args) > $work;
}
# we must have something in @args by now or we didn't find any
# valid query specification this time around
last SEQUENCE unless @args;
$self->debug(
'Parsed ', substr($query, $pos, pos($query) - $pos),
' into args [', join(', ', @args), ']'
) if DEBUG;
# we want to skip certain hack sequences like '* html'
if ($hack_sequence == 2) {
@elements = []; # clear out our stored elements to match behaviour of modern browsers
}
# we're just looking for any descendent
elsif( !$relationship ) {
if ($self->{match_self}) {
# if we are re-querying, be sure to match ourselves not just descendents
@elements = map { $_->look_down(@args) } @elements;
} else {
# look_down() will match self in addition to descendents,
# so we explicitly disallow matches on self as we iterate
# thru the list. The other cases below already exclude self.
# https://rt.cpan.org/Public/Bug/Display.html?id=58918
my @accumulator;
foreach my $e (@elements) {
if ($e->root() == $e) {
push(@accumulator, $e->look_down(@args));
}
else {
push(@accumulator, grep { $_ != $e } $e->look_down(@args));
}
}
@elements = @accumulator;
}
}
# immediate child selector
elsif( $relationship eq '>' ) {
@elements = map {
$_->look_down(
@args,
sub {
my $tag = shift;
my $root = $_;
return $tag->depth == $root->depth + 1;
}
)
} @elements;
}
# immediate sibling selector
elsif( $relationship eq '+' ) {
@elements = map {
$_->parent->look_down(
@args,
sub {
my $tag = shift;
my $root = $_;
my @prev_sibling = $tag->left;
# get prev next non-text sibling
foreach my $sibling (reverse @prev_sibling) {
next unless ref $sibling;
return $sibling == $root;
}
}
)
} @elements;
}
# grandchild selector
elsif( $relationship eq '*' ) {
@elements = map {
$_->look_down(
@args,
sub {
my $tag = shift;
my $root = $_;
return $tag->depth > $root->depth + 1;
}
)
} @elements;
}
# so we can check we've done something
$comops++;
# dedup the results we've gotten
@elements = $self->_dedup(\@elements);
map { warn $_->as_HTML } @elements if DEBUG;
}
if ($comops) {
$self->debug(
'Added', scalar(@elements), ' elements to results'
) if DEBUG;
my $selector = substr ($query,$startpos, $pos - $startpos);
$self->_add_specificity($selector,$specificity);
#add in the recent pass
push(@result,@elements);
# dedup the results across the result sets, necessary for comma based selectors
@result = $self->_dedup(\@result);
# sort the result set...
@result = sort _by_address @result;
# update op counter for complete query to include ops performed
# in this fragment
$ops += $comops;
}
else {
# looks like we got an empty comma section, e.g. : ",x, ,y,"
# so we'll ignore it
}
last COMMA unless $query =~ / \G \s*,\s* /cgsx;
}
# check for any trailing text in the query that we couldn't parse
if ($query =~ / \G (.+?) \s* $ /cgsx) {
return $self->_report_error( $self->message( bad_spec => $1, $query ) );
}
# check that we performed at least one query operation
unless ($ops) {
return $self->_report_error( $self->message( bad_query => $query ) );
}
return wantarray ? @result : $self->_new_match_self(@result);
}
# return elements stored from last query
sub get_elements {
my $self = shift;
return wantarray ? @{$self->{elements}} : $self->{elements};
}
###########################################################################################################
# from CSS spec at http://www.w3.org/TR/CSS21/cascade.html#specificity
###########################################################################################################
# A selector's specificity is calculated as follows:
#
# * count the number of ID attributes in the selector (= a)
# * count the number of other attributes and pseudo-classes in the selector (= b)
# * count the number of element names in the selector (= c)
# * ignore pseudo-elements.
#
# Concatenating the three numbers a-b-c (in a number system with a large base) gives the specificity.
#
# Example(s):
#
# Some examples:
#
# * {} /* a=0 b=0 c=0 -> specificity = 0 */
# LI {} /* a=0 b=0 c=1 -> specificity = 1 */
# UL LI {} /* a=0 b=0 c=2 -> specificity = 2 */
# UL OL+LI {} /* a=0 b=0 c=3 -> specificity = 3 */
# H1 + *[REL=up]{} /* a=0 b=1 c=1 -> specificity = 11 */
# UL OL LI.red {} /* a=0 b=1 c=3 -> specificity = 13 */
# LI.red.level {} /* a=0 b=2 c=1 -> specificity = 21 */
# #x34y {} /* a=1 b=0 c=0 -> specificity = 100 */
###########################################################################################################
=pod
=item specificity()
Calculate the specificity for any given passed selector, a critical factor in determining how best to apply the cascade
A selector's specificity is calculated as follows:
* count the number of ID attributes in the selector (= a)
* count the number of other attributes and pseudo-classes in the selector (= b)
* count the number of element names in the selector (= c)
* ignore pseudo-elements.
The specificity is based only on the form of the selector. In particular, a selector of the form "[id=p33]" is counted
as an attribute selector (a=0, b=0, c=1, d=0), even if the id attribute is defined as an "ID" in the source document's DTD.
See the following spec for additional details:
L<http://www.w3.org/TR/CSS21/cascade.html#specificity>
=back
=cut
sub get_specificity {
my ($self,$selector) = @_;
unless (exists $self->{specificity}->{$selector}) {
# if the invoking tree happened to be large this could get expensive real fast
# instead load up an empty instance and query that.
local $self->{elements} = [];
$self->query($selector);
}
return $self->{specificity}->{$selector};
}
sub suppress_errors {
my ($self, $setting) = @_;
if (defined($setting)) {
$self->{suppress_errors} = $setting;
}
return $self->{suppress_errors};
}
sub get_error {
my ($self) = @_;
return $self->{error};
}
sub list {
# return list of items or return unblessed list ref of items
return wantarray ? @{ $_[0] } : [ @{ $_[0] } ];
}
sub size {
my $self = shift;
return scalar @{$self->get_elements};
}
sub first {
my $self = shift;
return @{$self->get_elements} ? $self->get_elements->[0] : $self->error_msg('is_empty');
}
sub last {
my $self = shift;
return @{$self->get_elements} ? $self->get_elements->[-1] : $self->error_msg('is_empty');
}
####################################################################
#
# Everything below here is a private method subject to change
#
####################################################################
sub _add_specificity {
my ($self, $selector, $specificity) = @_;
$self->{specificity}->{$selector} = $specificity;
return();
}
sub _report_error {
my ($self, $message) = @_;
if ($self->suppress_errors()) {
if (defined($message)) {
$self->{error} = $message;
}
return undef;
}
else {
$self->error($message); # this will DIE
}
}
# this Just Works[tm] because first arg is HTML::Element object
sub _export_query_to_element {
class(ELEMENT)->load->method(
query => \&Query,
);
}
# remove duplicate elements in the case where elements are nested between multiple matching elements
sub _dedup {
my ($self,$elements) = @_;
my %seen = ();
my @unique = ();
foreach my $item (@{$elements}) {
if (!exists($seen{$item})) {
push(@unique, $item);
}
$seen{$item}++;
}
return @unique;
}
# utility method to assist in sorting of query return sets
sub _by_address
{
my $self = shift;
my @a = split /\./, $a->address();
my @b = split /\./, $b->address();
my $max = (scalar @a > scalar @b) ? scalar @a : scalar @b;
for (my $index=0; $index<$max; $index++) {
if (!defined($a[$index]) && !defined($b[$index])) {
return 0;
}
elsif (!defined($a[$index])) {
return -1;
}
elsif(!defined($b[$index])) {
return 1;
}
if ($a[$index] == $b[$index]) {
next; #move to the next
}
else {
return $a[$index] <=> $b[$index];
}
}
}
# instantiate an instance with match_self turned on, for use with
# follow-up queries, so they match the top-most elements.
sub _new_match_self {
my $self = shift;
my $result = $self->new(@_);
$result->{match_self} = 1;
return $result;
}
sub AUTOLOAD {
my $self = shift;
my ($method) = ($AUTOLOAD =~ /([^:]+)$/ );
return if $method eq 'DESTROY';
# we allow Perl to catch any unknown methods that the user might
# try to call against the HTML::Element objects in the query
my @results =
map { $_->$method(@_) }
@{$self->get_elements};
return wantarray ? @results : \@results;
}
1;
=head1 NAME
HTML::Query - jQuery-like selection queries for HTML::Element
=head1 SYNOPSIS
Creating an C<HTML::Query> object using the L<Query()|Query> constructor
subroutine:
use HTML::Query 'Query';
# using named parameters
$q = Query( text => $text ); # HTML text
$q = Query( file => $file ); # HTML file
$q = Query( tree => $tree ); # HTML::Element object
$q = Query( query => $query ); # HTML::Query object
$q = Query(
text => $text1, # or any combination
text => $text2, # of the above
file => $file1,
file => $file2,
tree => $tree,
query => $query,
);
# passing elements as positional arguments
$q = Query( $tree ); # HTML::Element object(s)
$q = Query( $tree1, $tree2, $tree3, ... );
# or from one or more existing queries
$q = Query( $query1 ); # HTML::Query object(s)
$q = Query( $query1, $query2, $query3, ... );
# or a mixture
$q = Query( $tree1, $query1, $tree2, $query2 );
# the final argument (in all cases) can be a selector
my $spec = 'ul.menu li a'; # <ul class="menu">..<li>..<a>
$q = Query( $tree, $spec );
$q = Query( $query, $spec );
$q = Query( $tree1, $tree2, $query1, $query2, $spec );
$q = Query( text => $text, $spec );
$q = Query( file => $file, $spec );
$q = Query( tree => $tree, $spec );
$q = Query( query => $query, $spec );
$q = Query(
text => $text,
file => $file,
# ...etc...
$spec
);
Or using the OO L<new()> constructor method (which the L<Query()|Query>
subroutine maps onto):
use HTML::Query;
$q = HTML::Query->new(
# accepts the same arguments as Query()
)
Or by monkey-patching a L<query()> method into L<HTML::Element|HTML::Element>.
use HTML::Query 'query'; # note lower case 'q'
use HTML::TreeBuilder;
# build a tree
my $tree = HTML::TreeBuilder->new;
$tree->parse_file($filename);
# call the query() method on any element
my $query = $tree->query($spec);
Once you have a query, you can start selecting elements:
@r = $q->query('a')->get_elements(); # all <a>...</a> elements
@r = $q->query('a#menu')->get_elements(); # all <a> with "menu" id
@r = $q->query('#menu')->get_elements(); # all elements with "menu" id
@r = $q->query('a.menu')->get_elements(); # all <a> with "menu" class
@r = $q->query('.menu')->get_elements(); # all elements with "menu" class
@r = $q->query('a[href]')->get_elements(); # all <a> with 'href' attr
@r = $q->query('a[href=foo]')->get_elements(); # all <a> with 'href="foo"' attr
# you can specify elements within elements...
@r = $q->query('ul.menu li a')->get_elements(); # <ul class="menu">...<li>...<a>
# and use commas to delimit multiple path specs for different elements
@r = $q->query('table tr td a, form input[type=submit]')->get_elements();
# query() in scalar context returns a new query
$r = $q->query('table')->get_elements();; # find all tables
$s = $r->query('tr')->get_elements(); # find all rows in all those tables
$t = $s->query('td')->get_elements(); # and all cells in those rows...
Inspecting query elements:
# get number of elements in query
my $size = $q->size
# get first/last element in query
my $first = $q->first;
my $last = $q->last;
# convert query to list or list ref of HTML::Element objects
my $list = $q->list; # list ref in scalar context
my @list = $q->list; # list in list context
All other methods are mapped onto the L<HTML::Element|HTML::Element> objects
in the query:
print $query->as_trimmed_text; # print trimmed text for each element
print $query->as_HTML; # print each element as HTML
$query->delete; # call delete() on each element
=head1 DESCRIPTION
The C<HTML::Query> module is an add-on for the L<HTML::Tree|HTML::Tree> module
set. It provides a simple way to select one or more elements from a tree using
a query syntax inspired by jQuery. This selector syntax will be reassuringly
familiar to anyone who has ever written a CSS selector.
C<HTML::Query> is not an attempt to provide a complete (or even near-complete)
implementation of jQuery in Perl (see Ingy's L<pQuery|pQuery> module for a
more ambitious attempt at that). Rather, it borrows some of the tried and
tested selector syntax from jQuery (and CSS) that can easily be mapped onto
the C<look_down()> method provided by the L<HTML::Element|HTML::Element>
module.
=head2 Creating a Query
The easiest way to create a query is using the exportable L<Query()|Query>
subroutine.
use HTML::Query 'Query'; # note capital 'Q'
It accepts a C<text> or C<file> named parameter and will create an
C<HTML::Query> object from the HTML source text or file, respectively.
my $query = Query( text => $text );
my $query = Query( file => $file );
This delegates to L<HTML::TreeBuilder|HTML::TreeBuilder> to parse the
HTML into a tree of L<HTML::Element|HTML::Element> objects. The root
element returned is then wrapped in an C<HTML::Query> object.
If you already have one or more L<HTML::Element|HTML::Element> objects that
you want to query then you can pass them to the L<Query()|Query> subroutine as
arguments. For example, you can explicitly use
L<HTML::TreeBuilder|HTML::TreeBuilder> to parse an HTML document into a tree:
use HTML::TreeBuilder;
my $tree = HTML::TreeBuilder->new;
$tree->parse_file($filename);
And then create an C<HTML::Query> object for the tree either using an
explicit C<tree> named parameter:
my $query = Query( tree => $tree );
Or implicitly using positional arguments.
my $query = Query( $tree );
If you want to query across multiple elements, then pass each one as a
positional argument.
my $query = Query( $tree1, $tree2, $tree3 );
You can also create a new query from one or more existing queries,
my $query = Query( query => $query ); # named parameter
my $query = Query( $query1, $query2 ); # positional arguments.
You can mix and match these different parameters and positional arguments
to create a query across several different sources.
$q = Query(
text => $text1,
text => $text2,
file => $file1,
file => $file2,
tree => $tree,
query => $query,
);
The L<Query()|Query> subroutine is a simple wrapper around the L<new()>
constructor method. You can instantiate your objects manually if you prefer.
The L<new()> method accepts the same arguments as for the L<Query()|Query>
subroutine (in fact, the L<Query()|Query> subroutine simply forwards all
arguments to the L<new()> method).
use HTML::Query;
my $query = HTML::Query->new(
# same argument format as for Query()
);
A final way to use C<HTML::Query> is to have it add a L<query()|query> method
to L<HTML::Element|HTML::Element>. The C<query> import hook (all lower
case) can be specified to make this so.
use HTML::Query 'query'; # note lower case 'q'
use HTML::TreeBuilder;
my $tree = HTML::TreeBuilder->new;
$tree->parse_file($filename);
# now all HTML::Elements have a query() method
my @items = $tree->query('ul li')->get_elements(); # find all list items
This approach, often referred to as I<monkey-patching>, should be used
carefully and sparingly. It involves a violation of
L<HTML::Element|HTML::Element>'s namespace that could have unpredictable
results with a future version of the module (e.g. one which defines its own
C<query()> method that does something different). Treat it as something that
is great to get a quick job done right now, but probably not something to be
used in production code without careful consideration of the implications.
=head2 Selecting Elements
Having created an C<HTML::Query> object by one of the methods outlined above,
you can now fetch descendant elements in the tree using a simple query syntax.
For example, to fetch all the C<< E<lt>aE<gt> >> elements in the tree, you can
write:
@links = $query->query('a')->get_elements();
Or, if you want the elements that have a specific C<class> attribute defined
with a value of, say C<menu>, you can write:
@links = $query->query('a.menu')->get_elements();
More generally, you can look for the existence of any attribute and optionally
provide a specific value for it.
@links = $query->query('a[href]')->get_elements(); # any href attribute
@links = $query->query('a[href=index.html]')->get_elements(); # specific value
You can also find an element (or elements) by specifying an id.
@links = $query->query('#menu')->get_elements(); # any element with id="menu"
@links = $query->query('ul#menu')->get_elements(); # ul element with id="menu"
You can provide multiple selection criteria to find elements within elements
within elements, and so on. For example, to find all links in a menu,
you can write:
# matches: <ul class="menu"> <li> <a>
@links = $query->query('ul.menu li a')->get_elements();
You can separate different criteria using commas. For example, to fetch all
table rows and C<span> elements with a C<foo> class:
@elems = $query->('table tr, span.foo')->get_elements();
=head2 Query Results
When called in list context, as shown in the examples above, the L<query()>
method returns a list of L<HTML::Element|HTML::Element> objects matching the
search criteria. In scalar context, the L<query()> method returns a new
C<HTML::Query> object containing the L<HTML::Element|HTML::Element> objects
found. You can then call the L<query()> method against that object to further
refine the query. The L<query()> method applies the selection to all elements
stored in the query.
my $tables = $query->query('table'); # query for tables
my $rows = $tables->query('tr'); # requery for all rows in those tables
my $cells = $rows->query('td')->get_elements(); # return back all the cells in those rows
=head2 Inspection Methods
The L<size()> method returns the number of elements in the query. The
L<first()> and L<last()> methods return the first and last items in the
query, respectively.
if ($query->size) {
print "from ", $query->first->as_trimmed_text, " to ", $query->last->as_trimmed_text;
}
If you want to extract the L<HTML::Element|HTML::Element> objects from the
query you can call the L<list()> method. This returns a list of
L<HTML::Element|HTML::Element> objects in list context, or a reference to a
list in scalar context.
@elems = $query->list;
$elems = $query->list;
=head2 Element Methods
Any other methods are automatically applied to each element in the list. For
example, to call the C<as_trimmed_text()> method on all the
L<HTML::Element|HTML::Element> objects in the query, you can write:
print $query->as_trimmed_text;
In list context, this method returns a list of the return values from
calling the method on each element. In scalar context it returns a
reference to a list of return values.
@text_blocks = $query->as_trimmed_text;
$text_blocks = $query->as_trimmed_text;
See L<HTML::Element|HTML::Element> for further information on the methods it
provides.
=head1 QUERY SYNTAX
=head2 Basic Selectors
=head3 element
Matches all elements of a particular type.
@elems = $query->query('table')->get_elements(); # <table>
=head3 #id
Matches all elements with a specific id attribute.
@elems = $query->query('#menu')->get_elements() # <ANY id="menu">
This can be combined with an element type:
@elems = $query->query('ul#menu')->get_elements(); # <ul id="menu">
=head3 .class
Matches all elements with a specific class attribute.
@elems = $query->query('.info')->get_elements(); # <ANY class="info">
This can be combined with an element type and/or element id:
@elems = $query->query('p.info')->get_elements(); # <p class="info">
@elems = $query->query('p#foo.info')->get_elements(); # <p id="foo" class="info">
@elems = $query->query('#foo.info')->get_elements(); # <ANY id="foo" class="info">
The selectors listed above can be combined in a whitespace delimited
sequence to select down through a hierarchy of elements. Consider the
following table:
<table class="search">
<tr class="result">
<td class="value">WE WANT THIS ELEMENT</td>
</tr>
<tr class="result">
<td class="value">AND THIS ONE</td>
</tr>
...etc..
</table>
To locate the cells that we're interested in, we can write:
@elems = $query->query('table.search tr.result td.value')->get_elements();