-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsearch_controller.py
1184 lines (888 loc) · 43.3 KB
/
search_controller.py
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
import sys
import json
import random
from datetime import datetime
from time import sleep
from threading import Thread
from typing import Any, Optional, Union
import selenium
from selenium.webdriver import ActionChains
from selenium.webdriver.common.by import By
from selenium.webdriver.common.keys import Keys
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
from selenium.common.exceptions import (
JavascriptException,
TimeoutException,
NoSuchElementException,
StaleElementReferenceException,
)
import hooks
from adb import adb_controller
from clicklogs_db import ClickLogsDB
from config_reader import config
from logger import logger
from stats import SearchStats
from utils import Direction, add_cookies, solve_recaptcha, get_random_sleep, resolve_redirect
LinkElement = selenium.webdriver.remote.webelement.WebElement
AdList = list[tuple[LinkElement, str, str]]
NonAdList = list[LinkElement]
AllLinks = list[Union[AdList, NonAdList]]
class SearchController:
"""Search controller for ad clicker
:type driver: selenium.webdriver
:param driver: Selenium Chrome webdriver instance
:type query: str
:param query: Search query
:type country_code: str
:param country_code: Country code for the proxy IP
"""
URL = "https://www.bing.com"
SEARCH_INPUT = (By.NAME, "q")
RESULTS_CONTAINER = (By.ID, "b_results")
COOKIE_DIALOG_CONTAINER = (By.ID, "bnp_cookie_banner")
COOKIE_DIALOG_BUTTON = (By.ID, "bnp_btn_accept")
TOP_ADS_CONTAINER = (By.CSS_SELECTOR, "li.b_adTop")
BOTTOM_ADS_CONTAINER = (By.CSS_SELECTOR, "li.b_adBottom")
AD_RESULTS = (By.CSS_SELECTOR, "h2 > a:last-child")
AD_CANON_LINK = (By.XPATH, "./../following-sibling::div//div[@class='b_adurl']")
AD_CANON_LINK_2 = (By.XPATH, "./../../following-sibling::div//div[@class='b_adurl']")
AD_CANON_LINK_3 = (By.XPATH, "./..//div[@class='b_adurl']")
AD_CANON_LINK_4 = (By.XPATH, "./../..//div[@class='b_adurl']")
NON_AD_LINKS = (By.CSS_SELECTOR, "li.b_algo")
NON_AD_LINK_ELEMENT = (By.CSS_SELECTOR, "div.b_title h2 a")
NON_AD_LINK_ELEMENT_2 = (By.CSS_SELECTOR, "div.b_algoheader a")
NON_AD_LINK_ELEMENT_3 = (By.CSS_SELECTOR, "a.tilk")
SHOPPING_ADS_CONTAINER = (By.CSS_SELECTOR, "div.b_cards2")
SHOPPING_ADS_CONTAINER_2 = (By.CSS_SELECTOR, "div.pa_item")
SHOPPING_AD_ELEMENT_CONTAINER = (By.CSS_SELECTOR, "li.pa_item")
SHOPPING_AD_ELEMENT = (By.TAG_NAME, "a")
SHOPPING_AD_TITLE_1 = (By.TAG_NAME, "h3")
SHOPPING_AD_TITLE_2 = (By.CSS_SELECTOR, "div.pa_title")
SHOPPING_AD_CANON_LINK_1 = (By.CSS_SELECTOR, "div.pa_url")
SHOPPING_AD_CANON_LINK_2 = (By.CSS_SELECTOR, "div.b_attribution")
RECAPTCHA = (By.ID, "recaptcha")
def __init__(
self, driver: selenium.webdriver, query: str, country_code: Optional[str] = None
) -> None:
self._driver = driver
self._search_query, self._filter_words = self._process_query(query)
self._exclude_list = None
self._random_mouse_enabled = config.behavior.random_mouse
self._use_custom_cookies = config.behavior.custom_cookies
self._twocaptcha_apikey = config.behavior.twocaptcha_apikey
self._max_scroll_limit = config.behavior.max_scroll_limit
self._hooks_enabled = config.behavior.hooks_enabled
self._ad_page_min_wait = config.behavior.ad_page_min_wait
self._ad_page_max_wait = config.behavior.ad_page_max_wait
self._nonad_page_min_wait = config.behavior.nonad_page_min_wait
self._nonad_page_max_wait = config.behavior.nonad_page_max_wait
self._android_device_id = None
self._stats = SearchStats()
if config.behavior.excludes:
self._exclude_list = [item.strip() for item in config.behavior.excludes.split(",")]
logger.debug(f"Words to be excluded: {self._exclude_list}")
if country_code:
self._set_start_url(country_code)
self._clicklogs_db_client = ClickLogsDB()
self._load()
def search_for_ads(
self, non_ad_domains: Optional[list[str]] = None
) -> tuple[AdList, NonAdList]:
"""Start search for the given query and return ads if any
Also, get non-ad links including domains given.
:type non_ad_domains: list
:param non_ad_domains: List of domains to select for non-ad links
:rtype: tuple
:returns: Tuple of [(ad, ad_link, ad_title), non_ad_links]
"""
if self._use_custom_cookies:
self._driver.delete_all_cookies()
add_cookies(self._driver)
for cookie in self._driver.get_cookies():
logger.debug(cookie)
self._check_captcha()
self._close_cookie_dialog()
logger.info(f"Starting search for '{self._search_query}'")
sleep(get_random_sleep(1, 3) * config.behavior.wait_factor)
try:
search_input_box = self._driver.find_element(*self.SEARCH_INPUT)
search_input_box.send_keys(self._search_query, Keys.ENTER)
except NoSuchElementException:
# self._check_captcha()
self._close_cookie_dialog()
search_input_box = self._driver.find_element(*self.SEARCH_INPUT)
search_input_box.send_keys(self._search_query, Keys.ENTER)
# wait 3 to 5 seconds before checking if results were loaded
sleep(get_random_sleep(3, 5) * config.behavior.wait_factor)
if self._hooks_enabled:
hooks.after_query_sent_hook(self._driver, self._search_query)
ad_links = []
non_ad_links = []
shopping_ad_links = []
try:
wait = WebDriverWait(self._driver, timeout=5)
results_loaded = wait.until(EC.presence_of_element_located(self.RESULTS_CONTAINER))
if results_loaded:
if self._hooks_enabled:
hooks.results_ready_hook(self._driver)
self._make_random_scrolls()
self._make_random_mouse_movements()
if config.behavior.check_shopping_ads:
shopping_ad_links = self._get_shopping_ad_links()
ad_links = self._get_ad_links()
non_ad_links = self._get_non_ad_links(non_ad_domains)
except TimeoutException:
logger.error("Timed out waiting for results!")
self.end_search()
return (ad_links, non_ad_links, shopping_ad_links)
def click_shopping_ads(self, shopping_ads: AdList) -> None:
"""Click shopping ads if there are any
:type shopping_ads: AdList
:param shopping_ads: List of (ad, ad_link, ad_title, ad_canon_link) tuples
"""
# store the ID of the original window
original_window_handle = self._driver.current_window_handle
for ad in shopping_ads:
try:
ad_link_element, ad_link, ad_title, ad_canon_link = self._extract_link_info(
ad, category="Shopping"
)
logger.info(f"Clicking to [{ad_title}]({ad_link}) | {ad_canon_link}...")
if self._hooks_enabled:
hooks.before_ad_click_hook(self._driver)
if config.behavior.send_to_android and self._android_device_id:
self._handle_android_click(ad_link_element, True, category="Shopping")
else:
self._handle_browser_click(
ad_link_element,
ad_canon_link,
True,
original_window_handle,
category="Shopping",
)
except Exception:
logger.debug(f"Failed to click ad element [{ad_title}]!")
def click_links(self, links: AllLinks) -> None:
"""Click links
:type links: AllLinks
:param links: List of [(ad, ad_link, ad_title, ad_canon_link), non_ad_links]
"""
# store the ID of the original window
original_window_handle = self._driver.current_window_handle
for link in links:
is_ad_element = isinstance(link, tuple)
try:
category = "Ad" if is_ad_element else "Non-ad"
if is_ad_element:
link_element, link_url, ad_title, canon_link = self._extract_link_info(
link, category
)
if self._hooks_enabled:
hooks.before_ad_click_hook(self._driver)
logger.info(f"Clicking to [{ad_title}]({link_url}) | '{canon_link}'...")
else:
link_element, link_url, ad_title, canon_link = self._extract_link_info(
link, category
)
logger.info(f"Clicking to [{link_url}]...")
# scroll the page to avoid elements remain outside of the view
self._driver.execute_script("arguments[0].scrollIntoView(true);", link_element)
sleep(get_random_sleep(0.5, 1) * config.behavior.wait_factor)
if config.behavior.send_to_android and self._android_device_id:
self._handle_android_click(link_element, is_ad_element, category)
else:
self._handle_browser_click(
link_element, canon_link, is_ad_element, original_window_handle, category
)
except StaleElementReferenceException:
logger.debug(
f"Ad element [{ad_title if is_ad_element else link_url}] has changed. Skipping scroll into view..."
)
except Exception:
logger.error(f"Failed to click on [{ad_title if is_ad_element else link_url}]!")
def _extract_link_info(self, link: Any, category: str) -> tuple:
"""Extract link information
:type link: tuple(ad, ad_link, ad_title, ad_canon_link) or LinkElement
:param link: (ad, ad_link, ad_title, ad_canon_link) for ads LinkElement for non-ads
:type category: str
:param category: Specifies link category as Ad, Non-ad, or Shopping
:rtype: tuple
:returns: (link_element, link_url, ad_title, canon_link) tuple
"""
if category == "Ad":
link_element = link[0]
link_url = link[1]
ad_title = link[2]
canon_link = link[3]
elif category == "Non-ad":
link_element = link
link_url = link.get_attribute("href")
ad_title = None
canon_link = None
elif category == "Shopping":
link_element = link[0]
link_url = link[1]
ad_title = link[2].replace("\n", " ")
canon_link = link[3]
return (link_element, link_url, ad_title, canon_link)
def _handle_android_click(
self,
link_element: selenium.webdriver.remote.webelement.WebElement,
is_ad_element: bool,
category: str = "Ad",
) -> None:
"""Handle opening link on Android device
:type link_element: selenium.webdriver.remote.webelement.WebElement
:param link_element: Link element
:type is_ad_element: bool
:param is_ad_element: Whether it is an ad or non-ad link
:type category: str
:param category: Specifies link category as Ad, Non-ad, or Shopping
"""
url = resolve_redirect(link_element.get_attribute("href"))
adb_controller.open_url(url, self._android_device_id)
click_time = datetime.now().strftime("%H:%M:%S")
# wait a little before starting random actions
sleep(get_random_sleep(2, 3) * config.behavior.wait_factor)
logger.debug(f"Current url on device: {url}")
if self._hooks_enabled and category in ("Ad", "Shopping"):
hooks.after_ad_click_hook(self._driver)
self._start_random_scroll_thread()
site_url = "/".join(url.split("/", maxsplit=3)[:3])
self._update_click_stats(site_url, click_time, category)
wait_time = self._get_wait_time(is_ad_element) * config.behavior.wait_factor
logger.debug(f"Waiting {wait_time} seconds on {category.lower()} page...")
sleep(wait_time)
adb_controller.close_browser()
sleep(get_random_sleep(0.5, 1) * config.behavior.wait_factor)
def _handle_browser_click(
self,
link_element: selenium.webdriver.remote.webelement.WebElement,
link_url: str,
is_ad_element: bool,
original_window_handle: str,
category: str = "Ad",
) -> None:
"""Handle clicking in the browser
:type link_element: selenium.webdriver.remote.webelement.WebElement
:param link_element: Link element
:type link_url: str
:param link_url: Canonical url for the clicked link
:type is_ad_element: bool
:param is_ad_element: Whether it is an ad or non-ad link
:type original_window_handle: str
:param original_window_handle: Window handle for the search results tab
:type category: str
:param category: Specifies link category as Ad, Non-ad, or Shopping
"""
self._open_link_in_new_tab(link_element)
if len(self._driver.window_handles) != 2:
logger.debug("Couldn't click! Scrolling element into view...")
self._driver.execute_script("arguments[0].scrollIntoView(true);", link_element)
self._open_link_in_new_tab(link_element)
if len(self._driver.window_handles) != 2:
logger.debug(f"Failed to open '{link_url}' in a new tab!")
return
else:
logger.debug("Opened link in a new tab. Switching to tab...")
for window_handle in self._driver.window_handles:
if window_handle != original_window_handle:
self._driver.switch_to.window(window_handle)
click_time = datetime.now().strftime("%H:%M:%S")
sleep(get_random_sleep(3, 5) * config.behavior.wait_factor)
logger.debug(f"Current url on new tab: {self._driver.current_url}")
if self._hooks_enabled and category in ("Ad", "Shopping"):
hooks.after_ad_click_hook(self._driver)
self._start_random_action_threads()
url = (
"/".join(self._driver.current_url.split("/", maxsplit=3)[:3])
if category == "Shopping"
else (link_url if is_ad_element else self._driver.current_url)
)
self._update_click_stats(url, click_time, category)
wait_time = self._get_wait_time(is_ad_element) * config.behavior.wait_factor
logger.debug(f"Waiting {wait_time} seconds on {category.lower()} page...")
sleep(wait_time)
self._driver.close()
break
# go back to the original window
self._driver.switch_to.window(original_window_handle)
sleep(get_random_sleep(1, 1.5) * config.behavior.wait_factor)
def _open_link_in_new_tab(
self, link_element: selenium.webdriver.remote.webelement.WebElement
) -> None:
"""Open the link in a new browser tab
:type link_element: selenium.webdriver.remote.webelement.WebElement
:param link_element: Link element
"""
platform = sys.platform
control_command_key = Keys.COMMAND if platform.endswith("darwin") else Keys.CONTROL
try:
actions = ActionChains(self._driver)
actions.move_to_element(link_element)
actions.key_down(control_command_key)
actions.click()
actions.key_up(control_command_key)
actions.perform()
sleep(get_random_sleep(0.5, 1) * config.behavior.wait_factor)
except JavascriptException as exp:
error_message = str(exp).split("\n")[0]
if "has no size and location" in error_message:
logger.error(
f"Failed to click element[{link_element.get_attribute('outerHTML')}]! "
"Skipping..."
)
def _get_wait_time(self, is_ad_element: bool) -> int:
"""Get wait time based on whether the link is an ad or non-ad
:type is_ad_element: bool
:param is_ad_element: Whether it is an ad or non-ad link
:rtype: int
:returns: Randomly selected number from the given range
"""
if is_ad_element:
return random.choice(range(self._ad_page_min_wait, self._ad_page_max_wait))
else:
return random.choice(range(self._nonad_page_min_wait, self._nonad_page_max_wait))
def _update_click_stats(self, url: str, click_time: str, category: str) -> None:
"""Update click statistics
:type url: str
:param url: Clicked link url to save db
:type click_time: str
:param click_time: Click time in hh:mm:ss format
:type category: str
:param category: Specifies link category as Ad, Non-ad, or Shopping
"""
if category == "Ad":
self._stats.ads_clicked += 1
elif category == "Non-ad":
self._stats.non_ads_clicked += 1
elif category == "Shopping":
self._stats.shopping_ads_clicked += 1
self._clicklogs_db_client.save_click(
site_url=url, category=category, query=self._search_query, click_time=click_time
)
def _start_random_scroll_thread(self) -> None:
"""Start a thread for random swipes on Android device"""
random_scroll_thread = Thread(target=self._make_random_swipes)
random_scroll_thread.start()
random_scroll_thread.join(
timeout=float(max(self._ad_page_max_wait, self._nonad_page_max_wait))
)
def _start_random_action_threads(self) -> None:
"""Start threads for random actions on browser"""
random_scroll_thread = Thread(target=self._make_random_scrolls)
random_scroll_thread.start()
random_mouse_thread = Thread(target=self._make_random_mouse_movements)
random_mouse_thread.start()
random_scroll_thread.join(
timeout=float(max(self._ad_page_max_wait, self._nonad_page_max_wait))
)
random_mouse_thread.join(
timeout=float(max(self._ad_page_max_wait, self._nonad_page_max_wait))
)
def end_search(self) -> None:
"""Close the browser.
Delete cookies and cache before closing.
"""
if self._driver:
try:
self._delete_cache_and_cookies()
self._driver.quit()
except Exception as exp:
logger.debug(exp)
self._driver = None
def _load(self) -> None:
"""Load Google main page"""
self._driver.get(self.URL)
def _get_shopping_ad_links(self) -> AdList:
"""Extract shopping ad links to click if exists
:rtype: AdList
:returns: List of (ad, ad_link, ad_title, ad_canon_link) tuples
"""
ads = []
try:
logger.info("Checking shopping ads...")
shopping_ads = self._driver.find_elements(*self.SHOPPING_ADS_CONTAINER)
if shopping_ads:
for shopping_ad in shopping_ads[:5]:
ad = shopping_ad.find_element(*self.SHOPPING_AD_ELEMENT_CONTAINER)
shopping_ad_element = ad.find_element(*self.SHOPPING_AD_ELEMENT)
shopping_ad_link = shopping_ad_element.get_attribute("href")
shopping_ad_title = (
ad.find_element(*self.SHOPPING_AD_TITLE_1).text.strip().replace("\n", " ")
)
shopping_ad_canon_link = ad.find_element(*self.SHOPPING_AD_CANON_LINK_1).text
ad_fields = (
shopping_ad_element,
shopping_ad_link,
shopping_ad_title,
shopping_ad_canon_link,
)
logger.debug(ad_fields)
ads.append(ad_fields)
else:
# try with different selector
shopping_ads = self._driver.find_elements(*self.SHOPPING_ADS_CONTAINER_2)
for shopping_ad in shopping_ads[:5]:
shopping_ad_element = shopping_ad.find_element(*self.SHOPPING_AD_ELEMENT)
shopping_ad_link = shopping_ad_element.get_attribute("href")
shopping_ad_title = (
shopping_ad_element.find_element(*self.SHOPPING_AD_TITLE_2)
.text.strip()
.replace("\n", " ")
)
shopping_ad_canon_link = shopping_ad.find_element(
*self.SHOPPING_AD_CANON_LINK_2
).text
ad_fields = (
shopping_ad_element,
shopping_ad_link,
shopping_ad_title,
shopping_ad_canon_link,
)
logger.debug(ad_fields)
ads.append(ad_fields)
self._stats.shopping_ads_found = len(ads)
if not ads:
return []
# if there are filter words given, filter results accordingly
filtered_ads = []
if self._filter_words:
for ad in ads:
ad_link = ad[1]
ad_title = ad[2].replace("\n", " ")
ad_canon_link = ad[3].lower()
for word in self._filter_words:
if word in ad_canon_link or word in ad_title.lower():
if ad not in filtered_ads:
logger.debug(f"Filtering [{ad_title}]: {ad_link} | {ad_canon_link}")
self._stats.num_filtered_shopping_ads += 1
filtered_ads.append(ad)
else:
filtered_ads = ads
shopping_ad_links = []
for ad in filtered_ads:
ad_link = ad[1]
ad_title = ad[2].replace("\n", " ")
ad_canon_link = ad[3].lower()
logger.debug(f"Ad title: {ad_title}, Ad link: {ad_link} | {ad_canon_link}")
if self._exclude_list:
for exclude_item in self._exclude_list:
if (
exclude_item in ad_canon_link
or exclude_item.lower() in ad_title.lower()
):
logger.debug(f"Excluding [{ad_title}]: {ad_link} | {ad_canon_link}")
self._stats.num_excluded_shopping_ads += 1
break
else:
logger.info("======= Found a Shopping Ad =======")
shopping_ad_links.append((ad[0], ad_link, ad_title, ad_canon_link))
else:
logger.info("======= Found a Shopping Ad =======")
shopping_ad_links.append((ad[0], ad_link, ad_title, ad_canon_link))
return shopping_ad_links
except NoSuchElementException:
logger.info("No shopping ads are shown!")
return ads
def _get_ad_links(self) -> AdList:
"""Extract ad links to click
:rtype: AdList
:returns: List of (ad, ad_link, ad_title, canon_link) tuples
"""
logger.info("Getting ad links...")
ads = []
scroll_count = 0
logger.debug(f"Max scroll limit: {self._max_scroll_limit}")
while not self._is_scroll_at_the_end():
try:
top_ads_containers = self._driver.find_elements(*self.TOP_ADS_CONTAINER)
for ad_container in top_ads_containers:
ads.extend(ad_container.find_elements(*self.AD_RESULTS))
except NoSuchElementException:
logger.debug("Could not found top ads!")
try:
bottom_ads_containers = self._driver.find_elements(*self.BOTTOM_ADS_CONTAINER)
for ad_container in bottom_ads_containers:
ads.extend(ad_container.find_elements(*self.AD_RESULTS))
except NoSuchElementException:
logger.debug("Could not found bottom ads!")
if self._max_scroll_limit > 0:
if scroll_count == self._max_scroll_limit:
logger.debug("Reached to max scroll limit! Ending scroll...")
break
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.PAGE_DOWN)
sleep(get_random_sleep(2, 2.5) * config.behavior.wait_factor)
scroll_count += 1
if not ads:
return []
# clean non-ad links and duplicates
cleaned_ads = []
links = []
for ad in ads:
ad_link = ad.get_attribute("href")
if ad_link not in links:
links.append(ad_link)
cleaned_ads.append(ad)
self._stats.ads_found = len(cleaned_ads)
# if there are filter words given, filter results accordingly
filtered_ads = []
if self._filter_words:
for ad in cleaned_ads:
ad_title = ad.text.strip().lower()
ad_link = ad.get_attribute("href")
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK)
except NoSuchElementException:
logger.debug("Checking with second alternative canonical link selector...")
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK_2)
except NoSuchElementException:
logger.debug("Checking with third alternative canonical link selector...")
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK_3)
except NoSuchElementException:
logger.debug(
"Checking with fourth alternative canonical link selector..."
)
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK_4)
except Exception:
logger.debug("Skipping...")
continue
canon_link = canon_link_element.text.strip()
logger.debug(f"canonical_link: '{canon_link}'")
for word in self._filter_words:
if word in canon_link or word in ad_title:
if ad not in filtered_ads:
logger.debug(f"Filtering [{ad_title}]: {ad_link} | '{canon_link}'")
self._stats.num_filtered_ads += 1
filtered_ads.append(ad)
else:
filtered_ads = cleaned_ads
ad_links = []
for ad in filtered_ads:
ad_link = ad.get_attribute("href")
ad_title = ad.text.strip()
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK)
except NoSuchElementException:
logger.debug("Checking with second alternative canonical link selector...")
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK_2)
except NoSuchElementException:
logger.debug("Checking with third alternative canonical link selector...")
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK_3)
except NoSuchElementException:
logger.debug("Checking with fourth alternative canonical link selector...")
try:
canon_link_element = ad.find_element(*self.AD_CANON_LINK_4)
except Exception:
logger.debug("Skipping...")
continue
canon_link = canon_link_element.text.strip()
logger.debug(f"Ad title: {ad_title}, Ad link: {ad_link} | '{canon_link}'")
if self._exclude_list:
for exclude_item in self._exclude_list:
if exclude_item in canon_link or exclude_item.lower() in ad_title.lower():
logger.debug(f"Excluding [{ad_title}]: {ad_link} | '{canon_link}'")
self._stats.num_excluded_ads += 1
break
else:
logger.info("======= Found an Ad =======")
ad_links.append((ad, ad_link, ad_title, canon_link))
else:
logger.info("======= Found an Ad =======")
ad_links.append((ad, ad_link, ad_title, canon_link))
return ad_links
def _get_non_ad_links(self, non_ad_domains: Optional[list[str]] = None) -> NonAdList:
"""Extract non-ad link elements
:type non_ad_domains: list
:param non_ad_domains: List of domains to select for non-ad links
:rtype: NonAdList
:returns: List of non-ad link elements
"""
logger.info("Getting non-ad links...")
# go to top of the page
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.HOME)
all_links = self._driver.find_elements(*self.NON_AD_LINKS)
logger.debug(f"Number of non-ad links: {len(all_links)}")
self._stats.non_ads_found = len(all_links)
non_ad_links = []
for link in all_links:
try:
link_element = link.find_element(*self.NON_AD_LINK_ELEMENT)
except NoSuchElementException:
logger.debug("Checking with second alternative non-ad selector...")
try:
link_element = link.find_element(*self.NON_AD_LINK_ELEMENT_2)
except NoSuchElementException:
logger.debug("Checking with third alternative non-ad selector...")
try:
link_element = link.find_element(*self.NON_AD_LINK_ELEMENT_3)
except NoSuchElementException:
logger.debug(
"Couldn't found non-ad link element in "
f"[{link.get_attribute('outerHTML')}]! Skipping..."
)
continue
link_url = link_element.get_attribute("href")
if non_ad_domains:
logger.debug(f"Evaluating [{link_url}] to add as non-ad link...")
for domain in non_ad_domains:
if domain in link_url:
logger.debug(f"Adding [{link_url}] to non-ad links")
self._stats.num_filtered_non_ads += 1
non_ad_links.append(link_element)
break
else:
logger.debug(f"Adding [{link_url}] to non-ad links")
non_ad_links.append(link_element)
logger.info(f"Found {len(non_ad_links)} non-ad links")
# if there is no domain to filter, randomly select 3 links
if not non_ad_domains and len(non_ad_links) > 3:
logger.info("Randomly selecting 3 from non-ad links...")
non_ad_links = random.sample(non_ad_links, k=3)
return non_ad_links
def _close_cookie_dialog(self) -> None:
"""If cookie dialog is opened, close it by accepting"""
logger.debug("Waiting for cookie dialog...")
sleep(get_random_sleep(3, 3.5) * config.behavior.wait_factor)
try:
cookie_dialog = self._driver.find_element(*self.COOKIE_DIALOG_CONTAINER)
accept_button = cookie_dialog.find_element(*self.COOKIE_DIALOG_BUTTON)
logger.info("Closing cookie dialog by accepting...")
accept_button.click()
sleep(get_random_sleep(1, 1.5) * config.behavior.wait_factor)
except NoSuchElementException:
logger.debug("No cookie dialog found! Continue with search...")
def _is_scroll_at_the_end(self) -> bool:
"""Check if scroll is at the end
:rtype: bool
:returns: Whether the scrollbar was reached to end or not
"""
page_height = self._driver.execute_script("return document.body.scrollHeight;")
total_scrolled_height = self._driver.execute_script(
"return window.pageYOffset + window.innerHeight;"
)
return page_height - 1 <= total_scrolled_height
def _delete_cache_and_cookies(self) -> None:
"""Delete browser cache, storage, and cookies"""
logger.debug("Deleting browser cache and cookies...")
try:
self._driver.delete_all_cookies()
self._driver.execute_cdp_cmd("Network.clearBrowserCache", {})
self._driver.execute_cdp_cmd("Network.clearBrowserCookies", {})
self._driver.execute_script("window.localStorage.clear();")
self._driver.execute_script("window.sessionStorage.clear();")
except Exception as exp:
if "not connected to DevTools" in str(exp):
logger.debug("Incognito mode is active. No need to delete cache. Skipping...")
def _set_start_url(self, country_code: str) -> None:
"""Set start url according to country code of the proxy IP
:type country_code: str
:param country_code: Country code for the proxy IP
"""
with open("domain_mapping.json", "r") as domains_file:
domains = json.load(domains_file)
country_domain = domains.get(country_code, "www.google.com")
self.URL = f"https://{country_domain}"
logger.debug(f"Start url was set to {self.URL}")
def _make_random_scrolls(self) -> None:
"""Make random scrolls on page"""
logger.debug("Making random scrolls...")
directions = [Direction.DOWN]
directions += random.choices(
[Direction.UP] * 5 + [Direction.DOWN] * 5, k=random.choice(range(1, 5))
)
logger.debug(f"Direction choices: {[d.value for d in directions]}")
for direction in directions:
if direction == Direction.DOWN and not self._is_scroll_at_the_end():
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.PAGE_DOWN)
elif direction == Direction.UP:
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.PAGE_UP)
sleep(get_random_sleep(1, 3) * config.behavior.wait_factor)
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.HOME)
def _make_random_swipes(self) -> None:
"""Make random swipes on page"""
logger.debug("Making random swipes...")
directions = [Direction.DOWN, Direction.DOWN]
directions += random.choices(
[Direction.UP] * 5 + [Direction.DOWN] * 5, k=random.choice(range(1, 5))
)
logger.debug(f"Direction choices: {[d.value for d in directions]}")
for direction in directions:
if direction == Direction.DOWN:
self._send_swipe(direction=Direction.DOWN)
elif direction == Direction.UP:
self._send_swipe(direction=Direction.UP)
sleep(get_random_sleep(1, 2) * config.behavior.wait_factor)
HOME_KEYCODE = 122
adb_controller.send_keyevent(HOME_KEYCODE) # go to top by sending Home key
def _send_swipe(self, direction: Direction) -> None:
"""Send swipe action to mobile device
:type direction: Direction
:param direction: Direction to swipe
"""
x_position = random.choice(range(100, 200))
duration = random.choice(range(100, 500))
if direction == Direction.DOWN:
y_start_position = random.choice(range(1000, 1500))
y_end_position = random.choice(range(500, 1000))
elif direction == Direction.UP:
y_start_position = random.choice(range(500, 1000))
y_end_position = random.choice(range(1000, 1500))
adb_controller.send_swipe(
x1=x_position,
y1=y_start_position,
x2=x_position,
y2=y_end_position,
duration=duration,
)
def _make_random_scrolls(self) -> None:
"""Make random scrolls on page"""
logger.debug("Making random scrolls...")
directions = [Direction.DOWN]
directions += random.choices(
[Direction.UP] * 5 + [Direction.DOWN] * 5, k=random.choice(range(1, 5))
)
logger.debug(f"Direction choices: {[d.value for d in directions]}")
for direction in directions:
if direction == Direction.DOWN and not self._is_scroll_at_the_end():
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.PAGE_DOWN)
elif direction == Direction.UP:
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.PAGE_UP)
sleep(get_random_sleep(1, 3) * config.behavior.wait_factor)
self._driver.find_element(By.TAG_NAME, "body").send_keys(Keys.HOME)
def _make_random_mouse_movements(self) -> None:
"""Make random mouse movements"""
if self._random_mouse_enabled: