{"id":275,"date":"2013-10-18T19:56:53","date_gmt":"2013-10-18T19:56:53","guid":{"rendered":"http:\/\/www.webtipblog.com\/?p=275"},"modified":"2013-12-03T20:16:07","modified_gmt":"2013-12-03T20:16:07","slug":"creating-a-crawler-in-symfony-2-using-the-domcrawler-and-client","status":"publish","type":"post","link":"https:\/\/www.webtipblog.com\/creating-a-crawler-in-symfony-2-using-the-domcrawler-and-client\/","title":{"rendered":"Creating a Crawler in Symfony 2 Using the DomCrawler and Client"},"content":{"rendered":"

There have been a few times where I have needed to crawl a Symfony 2 site to index pages and execute code so I built a crawler console command designed using the Symfony 2 DomCrawler and Client. This is a fun alternative to using curl, and the client offers plenty of browser-like features that come in handy, such as a saved history of visited pages or testing the forward and back button functionality on your pages. The authentication cookie below can be used for a curl request to protected pages as well if desired.<\/p>\n

The DomCrawler class allows you to manipulate the DOM while the Client class functions like a browser to make requests and receive responses, as well as follow links and submit forms. Symfony has documented how this works in the Testing chapter of The Book<\/a>, but I needed something that would work outside of unit and functional tests in the form of a console command that could be scheduled to run.<\/p>\n

 <\/p>\n

The crawler command is designed to take a few required arguments: the starting link to crawl and the username to authenticate with so restricted pages can be crawled. It also takes a few optional arguments: the number of pages to crawl at most to prevent the command from infinite crawling, keywords to search for in a route where a matching route should only be indexed once to prevent infinite crawling of dynamic links, and the name of a security firewall to authenticate with. To start, create the command class and set up the arguments and options.<\/p>\n

<?php\r\nnamespace Acme\\Bundle\\Command;\r\n\r\nuse Symfony\\Bundle\\FrameworkBundle\\Command\\ContainerAwareCommand;\r\nuse Symfony\\Component\\Console\\Input\\InputArgument;\r\nuse Symfony\\Component\\Console\\Input\\InputOption;\r\nuse Symfony\\Component\\Console\\Input\\InputInterface;\r\nuse Symfony\\Component\\Console\\Output\\OutputInterface;\r\n\r\nuse Symfony\\Component\\HttpFoundation\\RedirectResponse;\r\nuse Symfony\\Component\\DomCrawler\\Crawler;\r\nuse Symfony\\Component\\HttpKernel\\Client;\r\nuse Symfony\\Component\\BrowserKit\\Cookie;\r\n\r\nuse Symfony\\Component\\Security\\Core\\Authentication\\Token\\UsernamePasswordToken;\r\n\r\n\/**\r\n * This class crawls the Acme site\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com\r\n *\/\r\nclass SiteCrawlerCommand extends ContainerAwareCommand\r\n{\r\n     \/**\r\n     * @var OutputInterface\r\n     *\/\r\n    protected $output;\r\n\r\n    \/**\r\n     * @var Router\r\n     *\/\r\n    protected $router;\r\n\r\n    \/**\r\n     * @var EntityManager\r\n     *\/\r\n    protected $entityManager;\r\n\r\n    \/**\r\n     * @var string\r\n     *\/\r\n    protected $username = null;\r\n\r\n    \/**\r\n     * @var string\r\n     *\/\r\n    protected $securityFirewall = null;\r\n\r\n    \/**\r\n     * @var integer\r\n     *\/\r\n    protected $searchLimit;\r\n\r\n    \/**\r\n     * index routes containing these keywords only once\r\n     * @var array\r\n     *\/\r\n    protected $ignoredRouteKeywords;\r\n\r\n    \/**\r\n     * @var string\r\n     *\/\r\n    protected $domain = null;\r\n\r\n    \/**\r\n     * Configure\r\n     *\r\n     * @author  Joe Sexton <joe@webtipblog.com\r\n     *\/\r\n    protected function configure()\r\n    {\r\n        $this\r\n            ->setName( 'crawler:crawl' )\r\n            ->setDescription( 'Crawls the Acme website.' )\r\n            ->setDefinition(array(\r\n                new InputArgument( 'startingLink', InputArgument::REQUIRED, 'Link to start crawling' ),\r\n                new InputArgument( 'username', InputArgument::REQUIRED, 'Username' ),\r\n                new InputOption( 'limit', null, InputOption::VALUE_REQUIRED, 'Limit the number of links to process, prevents infinite crawling', 20 ),\r\n                new InputOption( 'security-firewall', null, InputOption::VALUE_REQUIRED, 'Firewall name', 'default_firewall' ),\r\n                new InputOption( 'ignore-duplicate-keyword', null, InputOption::VALUE_IS_ARRAY|InputOption::VALUE_REQUIRED, 'Index routes containing this keyword only one time (prevents infinite crawling of routes containng query parameters)', array() ),\r\n            ))\r\n            ->setHelp(<<<EOT\r\nThe <info>crawler:crawl<\/info> command crawls the Acme website:\r\n\r\n<info>php app\/console crawler:crawl <startingLink> <username><\/info>\r\nEOT\r\n            );\r\n    }\r\n\r\n    \/**\r\n     * Execute\r\n     *\r\n     * @author  Joe Sexton <joe@webtipblog.com\r\n     * @param   InputInterface $input\r\n     * @param   OutputInterface $output\r\n     * @todo    use product sitemap to crawl product pages\r\n     *\/\r\n    protected function execute( InputInterface $input, OutputInterface $output )\r\n    {\r\n        \/\/ user input\r\n        $startingLink               = $input->getArgument( 'startingLink' );\r\n        $this->domain               = parse_url( $startingLink, PHP_URL_HOST );\r\n        $this->username             = $input->getArgument( 'username' );\r\n        $this->searchLimit          = $input->getOption( 'limit' );\r\n        $this->securityFirewall     = $input->getOption( 'security-firewall' );\r\n        $this->ignoredRouteKeywords = $input->getOption( 'ignore-duplicate-keyword' );\r\n        $this->output               = $output;\r\n        $this->router               = $this->getContainer()->get( 'router' );\r\n        $this->entityManager        = $this->getContainer()->get( 'doctrine.orm.entity_manager' );\r\n\r\n        \/\/ start\r\n          $output->writeln('\r\n<info>A super-duper web crawler written by:\r\n\r\n   ___              _____           _\r\n  |_  |            \/  ___|         | |\r\n    | | ___   ___  \\ `--.  _____  _| |_ ___  _ __\r\n    | |\/ _ \\ \/ _ \\  `--. \\\/ _ \\ \\\/ \/ __\/ _ \\| |_ \\\r\n\/\\__\/ \/ (_) |  __\/ \/\\__\/ \/  __\/>  <| || (_) | | | |\r\n\\____\/ \\___\/ \\___| \\____\/ \\___\/_\/\\_\\\\__\\___\/|_| |_|\r\n\r\n<\/info>');\r\n\r\n    }\r\n\r\n     \/**\r\n     * Interact\r\n     *\r\n     * @author  Joe Sexton <joe@webtipblog.com\r\n     * @param   InputInterface $input\r\n     * @param   OutputInterface $output\r\n     *\/\r\n    protected function interact( InputInterface $input, OutputInterface $output )\r\n    {\r\n        if ( ! $input->getArgument( 'startingLink' ) ) {\r\n            $startingLink = $this->getHelper( 'dialog' )->askAndValidate(\r\n                $output,\r\n                'Please enter the link to start crawling:',\r\n                function( $startingLink ) {\r\n                    if ( empty( $startingLink ) ) {\r\n                        throw new \\Exception('starting link can not be empty');\r\n                    }\r\n\r\n                    return $startingLink;\r\n                }\r\n            );\r\n            $input->setArgument( 'startingLink', $startingLink );\r\n        }\r\n\r\n        if ( ! $input->getArgument( 'username' ) ) {\r\n            $username = $this->getHelper( 'dialog' )->askAndValidate(\r\n                $output,\r\n                'Please choose a username:',\r\n                function( $username ) {\r\n                    if ( empty( $username ) ) {\r\n                        throw new \\Exception( 'Username can not be empty' );\r\n                    }\r\n\r\n                    return $username;\r\n                }\r\n            );\r\n            $input->setArgument( 'username', $username );\r\n        }\r\n    }\r\n\r\n}<\/pre>\n
 <\/p>\n
The configure and interact methods set up the command to run and take arguments, more information on how that works can be found in the Symfony console documentation<\/a>.  The execute method starts by setting some class properties based on user input.  At this point you should be able to open your terminal and in your project directory run the command with php app\/console crawler:crawl<\/em>.<\/p>\n
 <\/p>\n
The next step is to create and boot the kernel, simply add this method to the SiteCrawlerCommand.<\/p>\n
\/**\r\n * createKernel\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com\r\n * @return  \\AppKernel\r\n *\/\r\nprotected function _createKernel() {\r\n\r\n    $rootDir = $this->getContainer()->get( 'kernel' )->getRootDir();\r\n    require_once( $rootDir . '\/AppKernel.php' );\r\n    $kernel = new \\AppKernel( 'test', true );\r\n    $kernel->boot();\r\n\r\n    return $kernel;\r\n}<\/pre>\n
 <\/p>\n
Then call _createKernel() by adding the following to the execute() method:<\/p>\n
$kernel = $this->_createKernel();<\/pre>\n
 <\/p>\n
Next, get the Symfony Client which is used to make the requests and retrieve page content.<\/p>\n
$client = $kernel->getContainer()->get( 'test.client' );<\/pre>\n
  <\/p>\n
In order to crawl pages that require a user to be logged in or posses certain roles, we’ll need to authenticate a user with those permissions.  Start by creating a an _authenticate() method as discussed in Symfony’s testing documentation<\/a>:<\/p>\n
\/**\r\n     * authenticate with a user account to access secured urls\r\n     *\r\n     * @author  Joe Sexton <joe@webtipblog.com\r\n     * @param   AppKernel $kernel\r\n     * @param   Client $client\r\n     *\/\r\n    protected function _authenticate( $kernel, $client ) {\r\n\r\n        \/\/ however you retrieve a user in your application\r\n        $user = $this->entityManager->getRepository( 'Entity:User' )->findOneByUsername( $this->username ); \r\n        $token = new UsernamePasswordToken( $user, null, $this->securityFirewall, $user->getRoles() );\r\n\r\n        \/\/ set session\r\n        $session = $client->getContainer()->get('session');\r\n        $session->set('_security_'.$this->securityFirewall, serialize($token));\r\n        $session->save();\r\n\r\n        \/\/ set cookie\r\n        $cookie = new Cookie($session->getName(), $session->getId());\r\n        $client->getCookieJar()->set($cookie);\r\n    }<\/pre>\n
 <\/p>\n
Of course we need to add a call to _authenticate from execute();<\/p>\n
$this->_authenticate( $kernel, $client );<\/pre>\n
 <\/p>\n
It’s time to request the starting page, adding these lines to execute() will get the first page and get a DomCrawler object with its contents.<\/p>\n
\/\/ start crawling\r\n$output->writeln( sprintf( 'Dominating <comment>%s<\/comment>, starting at <comment>%s<\/comment>.  At most, <comment>%s<\/comment> pages will be crawled.', $this->domain, $startingLink, $this->searchLimit ) );\r\n\r\n\/\/ crawl starting link\r\n$crawler = $client->request( 'GET', $startingLink );\r\n\r\n\/\/ redirect if necessary\r\nwhile ( $client->getResponse() instanceof RedirectResponse ) {\r\n    $crawler = $client->followRedirect();\r\n}<\/pre>\n
make sure to follow any redirects that your site may return<\/small><\/p>\n
 <\/p>\n
At this point you can do whatever you’d like to do with the DomCrawler that has been returned.  In my implementation I filtered all of the links on the page that were a part of the $domain<\/em> with this method.<\/p>\n
\/**\r\n * get all links on the page as an array of urls\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com\r\n * @param   Crawler $crawler\r\n * @return  array\r\n *\/\r\nprotected function _getLinksOnCurrentPage( Crawler $crawler ) {\r\n\r\n    $links = $crawler->filter( 'a' )->each( function ( Crawler $node, $i ) {\r\n            return $node->link()->getUri();\r\n        });\r\n\r\n    \/\/ remove outboundlinks\r\n    foreach ( $links as $key => $link ) {\r\n        $this->output->writeln( 'Link: '.$link );\r\n        $linkParts = parse_url( $link );\r\n        if ( empty( $linkParts['host'] ) || $linkParts['host'] !== $this->domain || $linkParts['scheme'] !== 'http' ) {\r\n\r\n            unset( $links[$key] );\r\n        }\r\n    }\r\n\r\n    return array_values( $links );\r\n}<\/pre>\n
 <\/p>\n
Then I added them to an array and processed each one, adding new links along the way until I ran out of links or reached the $searchLimit<\/em>.  <\/p>\n
 <\/p>\n
To see my full implementation, check out my SiteCrawlerCommand Gist<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
There have been a few times where I have needed to crawl a Symfony 2 site to index pages and execute code so I built a crawler console command designed using the Symfony 2 DomCrawler and Client. This is a fun alternative to using curl, and the client offers plenty of browser-like features that come […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[2],"tags":[25,4,20],"_links":{"self":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts\/275"}],"collection":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/comments?post=275"}],"version-history":[{"count":9,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts\/275\/revisions"}],"predecessor-version":[{"id":326,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts\/275\/revisions\/326"}],"wp:attachment":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/media?parent=275"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/categories?post=275"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/tags?post=275"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}