Merge pull request #145 from maxiaozhi/master

正则匹配成功时才替换掉html

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: querylist # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.gitignore

@@ -2,3 +2,4 @@
 .idea/
 composer.lock
 .DS_Store
+*.cache

README-ZH.md

@@ -29,7 +29,7 @@
 - .....
 
 ## 环境要求
-- PHP >= 7.0
+- PHP >= 7.1
 
 > 如果你的PHP版本还停留在PHP5，或者不会使用Composer,你可以选择使用QueryList3,QueryList3支持php5.3以及手动安装。
 QueryList3 文档:http://v3.querylist.cc

README.md

@@ -31,7 +31,7 @@ Through plug-ins you can easily implement things like:
 - .....
 
 ## Requirements
-- PHP >= 7.0
+- PHP >= 7.1
 
 ## Installation
 By Composer installation:

composer.json

@@ -4,10 +4,11 @@
     "keywords":["QueryList","phpQuery","spider"],
     "homepage": "http://querylist.cc",
     "require": {
-        "PHP":">=7.0",
+        "PHP":">=7.1",
-        "jaeger/phpquery-single": "^0.9",
+        "jaeger/phpquery-single": "^1",
-        "tightenco/collect": "^5",
+        "jaeger/g-http": "^1.1",
-        "jaeger/g-http": "^1.1"
+        "ext-dom": "*",
+        "tightenco/collect": ">5.0"
     },
     "suggest":{
 
@@ -31,6 +32,9 @@
     },
     "require-dev": {
         "symfony/var-dumper": "^3.3",
-        "phpunit/phpunit": "^7.5"
+        "phpunit/phpunit": "^8.5"
+    },
+    "scripts": {
+        "test": "./vendor/bin/phpunit"
     }
 }

src/Config.php

@@ -7,6 +7,7 @@
 
 namespace QL;
 use Closure;
+use Tightenco\Collect\Support\Collection;
 
 class Config
 {
@@ -20,8 +21,8 @@ class Config
      */
     public function __construct()
     {
-        $this->plugins = collect();
+        $this->plugins = new Collection();
-        $this->binds = collect();
+        $this->binds = new Collection();
     }
 
 

src/Dom/Elements.php

@@ -7,41 +7,43 @@
 
 namespace QL\Dom;
 
+use phpDocumentor\Reflection\Types\Null_;
 use phpQueryObject;
+use Tightenco\Collect\Support\Collection;
 
 /**
  * Class Elements
  * @package QL\Dom
  *
- * @method Elements toReference($var)
+ * @method Elements toReference(&$var)
- * @method  documentFragment($state)
+ * @method Elements documentFragment($state = null)
  * @method Elements toRoot()
- * @method Elements getDocumentIDRef($documentID)
+ * @method Elements getDocumentIDRef(&$documentID)
  * @method Elements getDocument()
- * @method  getDOMDocument()
+ * @method \DOMDocument getDOMDocument()
  * @method Elements getDocumentID()
  * @method Elements unloadDocument()
- * @method  isHTML()
+ * @method bool isHTML()
- * @method  isXHTML()
+ * @method bool isXHTML()
- * @method  isXML()
+ * @method bool isXML()
- * @method  serialize()
+ * @method string serialize()
- * @method  serializeArray($submit)
+ * @method array serializeArray($submit = null)
- * @method  get($index,$callback1,$callback2,$callback3)
+ * @method \DOMElement|\DOMElement[] get($index = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method  getString($index,$callback1,$callback2,$callback3)
+ * @method string|array getString($index = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method  getStrings($index,$callback1,$callback2,$callback3)
+ * @method string|array getStrings($index = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method  newInstance($newStack)
+ * @method Elements newInstance($newStack = null)
- * @method Elements find($selectors,$context,$noHistory)
+ * @method Elements find($selectors, $context = null, $noHistory = false)
- * @method Elements is($selector,$nodes)
+ * @method Elements|bool is($selector, $nodes = null)
- * @method Elements filterCallback($callback,$_skipHistory)
+ * @method Elements filterCallback($callback, $_skipHistory = false)
- * @method Elements filter($selectors,$_skipHistory)
+ * @method Elements filter($selectors, $_skipHistory = false)
- * @method  load($url,$data,$callback)
+ * @method Elements load($url, $data = null, $callback = null)
- * @method Elements trigger($type,$data)
+ * @method Elements trigger($type, $data = [])
- * @method Elements triggerHandler($type,$data)
+ * @method Elements triggerHandler($type, $data = [])
- * @method Elements bind($type,$data,$callback)
+ * @method Elements bind($type, $data, $callback = null)
- * @method  unbind($type,$callback)
+ * @method Elements unbind($type = null, $callback = null)
- * @method Elements change($callback)
+ * @method Elements change($callback = null)
- * @method Elements submit($callback)
+ * @method Elements submit($callback = null)
- * @method Elements click($callback)
+ * @method Elements click($callback = null)
  * @method Elements wrapAllOld($wrapper)
  * @method Elements wrapAll($wrapper)
  * @method Elements wrapAllPHP($codeBefore, $codeAfter)
@@ -51,26 +53,26 @@ use phpQueryObject;
  * @method Elements wrapInnerPHP($codeBefore, $codeAfter)
  * @method Elements contents()
  * @method Elements contentsUnwrap()
- * @method  switchWith($markup)
+ * @method Elements switchWith($markup)
  * @method Elements eq($num)
  * @method Elements size()
  * @method Elements length()
- * @method  count()
+ * @method int count()
- * @method Elements end($level)
+ * @method Elements end($level = 1)
  * @method Elements _clone()
  * @method Elements replaceWithPHP($code)
  * @method Elements replaceWith($content)
  * @method Elements replaceAll($selector)
- * @method Elements remove($selector)
+ * @method Elements remove($selector = null)
- * @method  markup($markup,$callback1,$callback2,$callback3)
+ * @method Elements|string markup($markup = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method  markupOuter($callback1,$callback2,$callback3)
+ * @method string markupOuter($callback1 = null, $callback2 = null, $callback3 = null)
- * @method  html($html,$callback1,$callback2,$callback3)
+ * @method Elements|string html($html = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method  xml($xml,$callback1,$callback2,$callback3)
+ * @method Elements|string xml($xml = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method  htmlOuter($callback1,$callback2,$callback3)
+ * @method string htmlOuter($callback1 = null, $callback2 = null, $callback3 = null)
- * @method  xmlOuter($callback1,$callback2,$callback3)
+ * @method string xmlOuter($callback1 = null, $callback2 = null, $callback3 = null)
  * @method Elements php($code)
- * @method  markupPHP($code)
+ * @method string markupPHP($code)
- * @method  markupOuterPHP()
+ * @method string markupOuterPHP()
  * @method Elements children($selector)
  * @method Elements ancestors($selector)
  * @method Elements append($content)
@@ -86,55 +88,51 @@ use phpQueryObject;
  * @method Elements afterPHP($content)
  * @method Elements insertAfter($seletor)
  * @method Elements insert($target, $type)
- * @method  index($subject)
+ * @method int index($subject)
- * @method Elements slice($start,$end)
+ * @method Elements slice($start, $end = null)
  * @method Elements reverse()
- * @method  text($text,$callback1,$callback2,$callback3)
+ * @method Elements|string text($text = null, $callback1 = null, $callback2 = null, $callback3 = null)
- * @method Elements plugin($class,$file)
+ * @method Elements plugin($class, $file = null)
- * @method  extend($class,$file)
+ * @method Elements _next($selector = null)
- * @method Elements _next($selector)
+ * @method Elements _prev($selector = null)
- * @method Elements _prev($selector)
+ * @method Elements prev($selector = null)
- * @method Elements prev($selector)
+ * @method Elements prevAll($selector = null)
- * @method Elements prevAll($selector)
+ * @method Elements nextAll($selector = null)
- * @method Elements nextAll($selector)
+ * @method Elements siblings($selector = null)
- * @method Elements siblings($selector)
+ * @method Elements not($selector = null)
- * @method Elements not($selector)
+ * @method Elements add($selector = null)
- * @method Elements add($selector)
+ * @method Elements parent($selector = null)
- * @method Elements parent($selector)
+ * @method Elements parents($selector = null)
- * @method Elements parents($selector)
+ * @method Elements stack($nodeTypes = null)
- * @method  stack($nodeTypes)
+ * @method Elements|string attr($attr = null, $value = null)
- * @method  attr($attr,$value)
  * @method Elements attrPHP($attr, $code)
  * @method Elements removeAttr($attr)
- * @method  val($val)
+ * @method Elements|string val($val = null)
  * @method Elements andSelf()
  * @method Elements addClass($className)
  * @method Elements addClassPHP($className)
- * @method  hasClass($className)
+ * @method bool hasClass($className)
  * @method Elements removeClass($className)
  * @method Elements toggleClass($className)
  * @method Elements _empty()
- * @method Elements each($callback,$param1,$param2,$param3)
+ * @method Elements callback($callback, $param1 = null, $param2 = null, $param3 = null)
- * @method Elements callback($callback,$param1,$param2,$param3)
+ * @method string data($key, $value = null)
- * @method  data($key,$value)
+ * @method Elements removeData($key)
- * @method  removeData($key)
+ * @method void rewind()
- * @method  rewind()
+ * @method Elements current()
- * @method  current()
+ * @method int key()
- * @method  key()
+ * @method Elements next($cssSelector = null)
- * @method Elements next($cssSelector)
+ * @method bool valid()
- * @method  valid()
+ * @method bool offsetExists($offset)
- * @method  offsetExists($offset)
+ * @method Elements offsetGet($offset)
- * @method  offsetGet($offset)
+ * @method void offsetSet($offset, $value)
- * @method  offsetSet($offset,$value)
+ * @method string whois($oneNode)
- * @method  offsetUnset($offset)
- * @method  whois($oneNode)
  * @method Elements dump()
- * @method  dumpWhois()
+ * @method Elements dumpWhois()
- * @method  dumpLength()
+ * @method Elements dumpLength()
- * @method  dumpTree($html,$title)
+ * @method Elements dumpTree($html, $title)
  * @method  dumpDie()
  */
-
 class Elements
 {
     /**
@@ -167,15 +165,34 @@ class Elements
         return $obj;
     }
 
+    /**
+     * Iterating elements
+     *
+     * @param callable $callback
+     *
+     * @return $this
+     */
+    public function each(callable $callback)
+    {
+        foreach ($this->elements as $key => $element) {
+            $break = $callback(new self(pq($element)), $key);
+            if ($break === false) {
+                break;
+            }
+        }
+
+        return $this;
+    }
+
     /**
      * Iterating elements
      *
      * @param $callback
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection|\Tightenco\Collect\Support\Collection
      */
     public function map($callback)
     {
-        $collection = collect();
+        $collection = new Collection();
         $this->elements->each(function ($dom) use (& $collection, $callback) {
             $collection->push($callback(new self(pq($dom))));
         });
@@ -185,8 +202,8 @@ class Elements
     /**
      * Gets the attributes of all the elements
      *
-     * @param $attr HTML attribute name
+     * @param string $attr HTML attribute name
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection|\Tightenco\Collect\Support\Collection
      */
     public function attrs($attr)
     {
@@ -198,7 +215,7 @@ class Elements
     /**
      * Gets the text of all the elements
      *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection|\Tightenco\Collect\Support\Collection
      */
     public function texts()
     {
@@ -210,7 +227,7 @@ class Elements
     /**
      * Gets the html of all the elements
      *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection|\Tightenco\Collect\Support\Collection
      */
     public function htmls()
     {
@@ -219,6 +236,19 @@ class Elements
         });
     }
 
+    /**
+     * Gets the htmlOuter of all the elements
+     *
+     * @return \Illuminate\Support\Collection|\Tightenco\Collect\Support\Collection
+     */
+    public function htmlOuters()
+    {
+        return $this->map(function ($item) {
+            return trim($item->htmlOuter());
+        });
+    }
+
+
     /**
      * @return phpQueryObject
      */

src/Dom/Query.php

@@ -9,12 +9,16 @@ namespace QL\Dom;
 
 use Tightenco\Collect\Support\Collection;
 use phpQuery;
+use phpQueryObject;
 use QL\QueryList;
 use Closure;
 
 class Query
 {
     protected $html;
+    /**
+     * @var \phpQueryObject
+     */
     protected $document;
     protected $rules;
     protected $range = null;
@@ -31,11 +35,12 @@ class Query
     }
 
     /**
-     * @return mixed
+     * @param bool $rel
+     * @return String
      */
-    public function getHtml()
+    public function getHtml($rel = true)
     {
-        return $this->html;
+        return $rel ? $this->document->htmlOuter() : $this->html;
     }
 
     /**
@@ -46,6 +51,7 @@ class Query
     public function setHtml($html, $charset = null)
     {
         $this->html = value($html);
+        $this->destroyDocument();
         $this->document = phpQuery::newDocumentHTML($this->html, $charset);
         return $this->ql;
     }
@@ -58,7 +64,7 @@ class Query
      */
     public function getData(Closure $callback = null)
     {
-        return  is_null($callback) ? $this->data : $this->data->map($callback);
+        return $this->handleData($this->data, $callback);
     }
 
     /**
@@ -119,8 +125,8 @@ class Query
      */
     public function removeHead()
     {
-        $html = preg_replace('/<head.+?>.+<\/head>/is','<head></head>',$this->html);
+        $html = preg_replace('/(<head>|<head\s+.+?>).+?<\/head>/is', '<head></head>', $this->html);
-        $this->setHtml($html);
+        $html && $this->setHtml($html);
         return $this->ql;
     }
 
@@ -133,66 +139,102 @@ class Query
     public function query(Closure $callback = null)
     {
         $this->data = $this->getList();
-        $callback && $this->data = $this->data->map($callback);
+        $this->data = $this->handleData($this->data, $callback);
         return $this->ql;
     }
 
+    public function handleData(Collection $data, $callback)
+    {
+        if (is_callable($callback)) {
+            if (empty($this->range)) {
+                $data = new Collection($callback($data->all(), null));
+            } else {
+                $data = $data->map($callback);
+            }
+        }
+
+        return $data;
+    }
+
     protected function getList()
     {
         $data = [];
-        if (!empty($this->range)) {
+        if (empty($this->range)) {
-            $robj = $this->document->find($this->range);
-            $i = 0;
-            foreach ($robj as $item) {
             foreach ($this->rules as $key => $reg_value) {
-                    $tags = $reg_value[2] ?? '';
+                $rule = $this->parseRule($reg_value);
-                    $iobj = pq($item,$this->document)->find($reg_value[0]);
+                $contentElements = $this->document->find($rule['selector']);
-                    switch ($reg_value[1]) {
+                $data[$key] = $this->extractContent($contentElements, $key, $rule);
-                        case 'text':
-                            $data[$i][$key] = $this->allowTags(pq($iobj)->html(),$tags);
-                            break;
-                        case 'html':
-                            $data[$i][$key] = $this->stripTags(pq($iobj)->html(),$tags);
-                            break;
-                        default:
-                            $data[$i][$key] = pq($iobj)->attr($reg_value[1]);
-                            break;
-                    }
-
-                    if(isset($reg_value[3])){
-                        $data[$i][$key] = call_user_func($reg_value[3],$data[$i][$key],$key);
-                    }
-                }
-                $i++;
             }
         } else {
-            foreach ($this->rules as $key => $reg_value){
+            $rangeElements = $this->document->find($this->range);
-                $tags = $reg_value[2] ?? '';
-                $lobj = $this->document->find($reg_value[0]);
             $i = 0;
-                foreach ($lobj as $item) {
+            foreach ($rangeElements as $element) {
-                    switch ($reg_value[1]) {
+                foreach ($this->rules as $key => $reg_value) {
-                        case 'text':
+                    $rule = $this->parseRule($reg_value);
-                            $data[$i][$key] = $this->allowTags(pq($item,$this->document)->html(),$tags);
+                    $contentElements = pq($element)->find($rule['selector']);
-                            break;
+                    $data[$i][$key] = $this->extractContent($contentElements, $key, $rule);
-                        case 'html':
-                            $data[$i][$key] = $this->stripTags(pq($item,$this->document)->html(),$tags);
-                            break;
-                        default:
-                            $data[$i][$key] = pq($item,$this->document)->attr($reg_value[1]);
-                            break;
                 }
-
-                    if(isset($reg_value[3])){
-                        $data[$i][$key] = call_user_func($reg_value[3],$data[$i][$key],$key);
-                    }
-
                 $i++;
             }
         }
+
+        return new Collection($data);
     }
-//        phpQuery::$documents = array();
+
-        return collect($data);
+    protected function extractContent(phpQueryObject $pqObj, $ruleName, $rule)
+    {
+        switch ($rule['attr']) {
+            case 'text':
+                $content = $this->allowTags($pqObj->html(), $rule['filter_tags']);
+                break;
+            case 'texts':
+                $content = (new Elements($pqObj))->map(function (Elements $element) use ($rule) {
+                    return $this->allowTags($element->html(), $rule['filter_tags']);
+                })->all();
+                break;
+            case 'html':
+                $content = $this->stripTags($pqObj->html(), $rule['filter_tags']);
+                break;
+            case 'htmls':
+                $content = (new Elements($pqObj))->map(function (Elements $element) use ($rule) {
+                    return $this->stripTags($element->html(), $rule['filter_tags']);
+                })->all();
+                break;
+            case 'htmlOuter':
+                $content = $this->stripTags($pqObj->htmlOuter(), $rule['filter_tags']);
+                break;
+            case 'htmlOuters':
+                $content = (new Elements($pqObj))->map(function (Elements $element) use ($rule) {
+                    return $this->stripTags($element->htmlOuter(), $rule['filter_tags']);
+                })->all();
+                break;
+            default:
+                if(preg_match('/attr\((.+)\)/', $rule['attr'], $arr)) {
+                    $content = $pqObj->attr($arr[1]);
+                } elseif (preg_match('/attrs\((.+)\)/', $rule['attr'], $arr)) {
+                    $content = (new Elements($pqObj))->attrs($arr[1])->all();
+                } else {
+                    $content = $pqObj->attr($rule['attr']);
+                }
+                break;
+        }
+
+        if (is_callable($rule['handle_callback'])) {
+            $content = call_user_func($rule['handle_callback'], $content, $ruleName);
+        }
+
+        return $content;
+    }
+
+    protected function parseRule($rule)
+    {
+        $result = [];
+        $result['selector'] = $rule[0];
+        $result['attr'] = $rule[1];
+        $result['filter_tags'] = $rule[2] ?? '';
+        $result['handle_callback'] = $rule[3] ?? null;
+
+        return $result;
     }
 
     /**
@@ -234,10 +276,8 @@ class Query
     {
         $tagArr = preg_split("/\s+/", $tags_str, -1, PREG_SPLIT_NO_EMPTY);
         $tags = array(array(), array());
-        foreach($tagArr as $tag)
+        foreach ($tagArr as $tag) {
-        {
+            if (preg_match('/-(.+)/', $tag, $arr)) {
-            if(preg_match('/-(.+)/', $tag,$arr))
-            {
                 array_push($tags[1], $arr[1]);
             } else {
                 array_push($tags[0], $tag);
@@ -255,8 +295,7 @@ class Query
     protected function removeTags($html, $tags)
     {
         $tag_str = '';
-        if(count($tags))
+        if (count($tags)) {
-        {
             foreach ($tags as $tag) {
                 $tag_str .= $tag_str ? ',' . $tag : $tag;
             }
@@ -268,4 +307,16 @@ class Query
         }
         return $html;
     }
+
+    protected function destroyDocument()
+    {
+        if ($this->document instanceof phpQueryObject) {
+            $this->document->unloadDocument();
+        }
+    }
+
+    public function __destruct()
+    {
+        $this->destroyDocument();
+    }
 }

src/Kernel.php

@@ -14,6 +14,7 @@ use Closure;
 use QL\Providers\HttpServiceProvider;
 use QL\Providers\PluginServiceProvider;
 use QL\Providers\SystemServiceProvider;
+use Tightenco\Collect\Support\Collection;
 
 class Kernel
 {
@@ -34,7 +35,7 @@ class Kernel
     public function __construct(QueryList $ql)
     {
         $this->ql = $ql;
-        $this->binds = collect();
+        $this->binds = new Collection();
     }
 
     public function bootstrap()

src/QueryList.php

@@ -23,7 +23,7 @@ use QL\Services\MultiRequestService;
  * Class QueryList
  * @package QL
  *
- * @method string getHtml()
+ * @method string getHtml($rel = true)
  * @method QueryList setHtml($html)
  * @method QueryList html($html)
  * @method Dom\Elements find($selector)
@@ -104,6 +104,15 @@ class QueryList
      * Destruction of resources
      */
     public function destruct()
+    {
+        unset($this->query);
+        unset($this->kernel);
+    }
+
+    /**
+     * Destroy all documents
+     */
+    public static function destructDocuments()
     {
         phpQuery::$documents = [];
     }

tests/Dom/FindTest.php

@@ -17,7 +17,7 @@ class FindTest extends TestCaseBase
     protected $html;
     protected $ql;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->html = $this->getSnippet('snippet-1');
         $this->ql = QueryList::html($this->html);

tests/Dom/RulesTest.php

@@ -18,7 +18,7 @@ class RulesTest extends TestCaseBase
     protected $html;
     protected $ql;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->html = $this->getSnippet('snippet-2');
         $this->ql = QueryList::html($this->html);

tests/Feature/HttpTest.php

@@ -18,7 +18,7 @@ class HttpTest extends TestCaseBase
 {
     protected $urls;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->urls = [
             'http://httpbin.org/get?name=php',

tests/Feature/InstanceTest.php

@@ -16,7 +16,7 @@ class InstanceTest extends TestCaseBase
 {
     protected $html;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->html = $this->getSnippet('snippet-1');
     }
@@ -38,11 +38,11 @@ class InstanceTest extends TestCaseBase
     public function get_new_object()
     {
         $ql = (new QueryList())->html($this->html);
-        $ql2 = new QueryList();
+        $ql2 = (new QueryList())->html('');
         $this->assertNotEquals($ql->getHtml(),$ql2->getHtml());
 
         $ql = QueryList::range('')->html($this->html);
-        $ql2 = QueryList::range('');
+        $ql2 = QueryList::range('')->html('');
         $this->assertNotEquals($ql->getHtml(),$ql2->getHtml());
     }
 }

tests/Feature/MethodTest.php

@@ -16,7 +16,7 @@ class MethodTest extends TestCaseBase
 {
     protected $html;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->html = $this->getSnippet('snippet-1');
     }
@@ -30,7 +30,7 @@ class MethodTest extends TestCaseBase
         $qlHtml = QueryList::pipe(function(QueryList $ql) use($html){
             $ql->setHtml($html);
             return $ql;
-        })->getHtml();
+        })->getHtml(false);
         $this->assertEquals($html,$qlHtml);
     }
 }