Skip to content

Implement CLI progress into infinite crawler #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 14, 2020
Merged

Implement CLI progress into infinite crawler #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
889ee5d
get things working
crstauf Jun 14, 2020
3437b89
implement progress bar
crstauf Jun 14, 2020
d30bd58
add debug output
crstauf Jun 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/CLI.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,13 @@ public function generate() : void {

$plugin = Controller::getInstance();
WP_CLI::log( 'Generating file list' );
$plugin->generate_filelist_preview();
$plugin->detect_urls();
WP_CLI::log( 'Preparing for export' );
$plugin->prepare_for_export();

$site_crawler = new SiteCrawler();

$site_crawler->crawl_site();
$site_crawler->crawl_discovered_links();
WP_CLI::log( 'Performing post process actions' );
$plugin->post_process_archive_dir();

Expand Down
5 changes: 1 addition & 4 deletions src/FilesHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,14 +389,11 @@ public static function getAllWPPostURLs( string $wp_site_url ) : array {
case 'page':
$permalink = get_page_link( $post->ID );
break;
case 'post':
$permalink = get_permalink( $post->ID );
break;
case 'attachment':
$permalink = get_attachment_link( $post->ID );
break;
default:
$permalink = get_post_permalink( $post->ID );
$permalink = get_permalink( $post->ID );
break;
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/HTMLProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,7 @@ public function addDiscoveredURL( string $url ) : void {
if ( $this->isInternalLink( (string) $url ) ) {
$path = (string) parse_url( (string) $url, PHP_URL_PATH );

if ( $path[0] !== '/' ) {
if ( empty( $path ) || $path[0] !== '/' ) {
return;
}

Expand Down
46 changes: 31 additions & 15 deletions src/SiteCrawler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,19 @@ public function crawl_site() : void {
} else {
if ( ! defined( 'WP_CLI' ) ) {
echo 'SUCCESS';
} else if ( !empty( $this->progress_bar ) ) {
$this->progress_bar->finish();
}
}
}

public function progressBarTick() : void {
if ( empty( $this->progress_bar ) ) {
return;
}

$this->progress_bar->tick( 1, sprintf( 'Processing URLs %d / %d', filter_var( $this->progress_bar->current(), FILTER_SANITIZE_NUMBER_INT ) + 1, CrawlLog::getTotalCrawlableURLs() ) );
}

public function crawlABitMore() : void {
$batch_of_links_to_crawl = [];
Expand All @@ -118,11 +128,14 @@ public function crawlABitMore() : void {

$this->archive_dir = $this->settings['wp_uploads_path'] . '/static-html-output/';

// TODO: modify this to show Detected / Crawled URL progress
// if ( defined( 'WP_CLI' ) && empty( $this->progress_bar ) ) {
// $this->progress_bar =
// \WP_CLI\Utils\make_progress_bar( 'Crawling site', $total_urls_to_crawl );
// }
if ( defined( 'WP_CLI' ) && empty( $this->progress_bar ) ) {
$this->progress_bar =
\WP_CLI\Utils\make_progress_bar( sprintf( 'Processing URLs %d / %d', 0, CrawlLog::getTotalCrawlableURLs() ), CrawlLog::getTotalCrawlableURLs() );
}

if ( ! empty( $this->progress_bar ) ) {
$this->progress_bar->setTotal( CrawlLog::getTotalCrawlableURLs() );
}

// TODO: add these to Exclusions table
$exclusions = [ 'wp-json' ];
Expand Down Expand Up @@ -157,19 +170,15 @@ public function crawlABitMore() : void {
$url_path = (string) parse_url( $this->url, PHP_URL_PATH );

if ( ! $url_path ) {
$this->progressBarTick();
continue 2;
}

// TODO: dummy status to denote skipped due to exclusion rule
CrawlLog::updateStatus( $url_path, 777 );
CrawlQueue::removeURL( $url_path );

// TODO: reimplement progress bar
// if ( ! empty( $this->progress_bar ) ) {
// $this->progress_bar->tick();
// }

// skip the outer foreach loop
$this->progressBarTick();
continue 2;
}
}
Expand All @@ -185,10 +194,7 @@ public function crawlABitMore() : void {

// ProgressLog::l( $completed_urls, $total_urls_to_crawl );

// TODO: reimplement progress bar
// if ( ! empty( $this->progress_bar ) ) {
// $this->progress_bar->tick();
// }
$this->progressBarTick();
}

$this->checkIfMoreCrawlingNeeded();
Expand Down Expand Up @@ -393,6 +399,10 @@ public function loadFileForProcessing() : bool {
break;
}

if ( defined( 'WP_CLI' ) ) {
\WP_CLI::debug( sprintf( 'Processing %s', $this->url ) );
}

return true;
}

Expand All @@ -408,6 +418,8 @@ public function checkIfMoreCrawlingNeeded() : void {
} else {
if ( ! defined( 'WP_CLI' ) ) {
echo 'SUCCESS';
} else if ( !empty( $this->progress_bar ) ) {
$this->progress_bar->finish();
}
}
}
Expand All @@ -421,6 +433,10 @@ public function saveFile() : void {
);

$file_writer->saveFile( $this->archive_dir );

if ( defined( 'WP_CLI' ) ) {
\WP_CLI::debug( sprintf( 'Saved %s', $this->url ) );
}
}

public function getExtensionFromURL() : string {
Expand Down