google_robotstxt_parser 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +28 -0
- data/.gitmodules +3 -0
- data/CHANGELOG.md +5 -0
- data/CODE_OF_CONDUCT.md +46 -0
- data/Gemfile +6 -0
- data/Guardfile +16 -0
- data/LICENSE +22 -0
- data/README.md +57 -0
- data/Rakefile +6 -0
- data/ext/robotstxt/.DS_Store +0 -0
- data/ext/robotstxt/extconf.rb +83 -0
- data/ext/robotstxt/robotstxt/.gitignore +1 -0
- data/ext/robotstxt/robotstxt/BUILD +40 -0
- data/ext/robotstxt/robotstxt/CMakeLists.txt +174 -0
- data/ext/robotstxt/robotstxt/CMakeLists.txt.in +30 -0
- data/ext/robotstxt/robotstxt/CONTRIBUTING.md +30 -0
- data/ext/robotstxt/robotstxt/LICENSE +203 -0
- data/ext/robotstxt/robotstxt/README.md +134 -0
- data/ext/robotstxt/robotstxt/WORKSPACE +28 -0
- data/ext/robotstxt/robotstxt/protocol-draft/README.md +9 -0
- data/ext/robotstxt/robotstxt/protocol-draft/draft-koster-rep-00.txt +529 -0
- data/ext/robotstxt/robotstxt/robots.cc +706 -0
- data/ext/robotstxt/robotstxt/robots.h +241 -0
- data/ext/robotstxt/robotstxt/robots_main.cc +101 -0
- data/ext/robotstxt/robotstxt/robots_test.cc +990 -0
- data/ext/robotstxt/robotstxt.cc +32 -0
- data/google_robotstxt_parser.gemspec +45 -0
- data/lib/google_robotstxt_parser/version.rb +6 -0
- data/lib/google_robotstxt_parser.rb +4 -0
- data/spec/google_robotstxt_parser_spec.rb +33 -0
- data/spec/spec_helper.rb +19 -0
- metadata +146 -0
@@ -0,0 +1,203 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
https://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
https://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
203
|
+
|
@@ -0,0 +1,134 @@
|
|
1
|
+
|
2
|
+
# Google Robots.txt Parser and Matcher Library
|
3
|
+
|
4
|
+
The repository contains Google's robots.txt parser and matcher as a C++ library
|
5
|
+
(compliant to C++11).
|
6
|
+
|
7
|
+
## About the library
|
8
|
+
|
9
|
+
The Robots Exclusion Protocol (REP) is a standard that enables website owners to
|
10
|
+
control which URLs may be accessed by automated clients (i.e. crawlers) through
|
11
|
+
a simple text file with a specific syntax. It's one of the basic building blocks
|
12
|
+
of the internet as we know it and what allows search engines to operate.
|
13
|
+
|
14
|
+
Because the REP was only a de-facto standard for the past 25 years, different
|
15
|
+
implementers implement parsing of robots.txt slightly differently, leading to
|
16
|
+
confusion. This project aims to fix that by releasing the parser that Google
|
17
|
+
uses.
|
18
|
+
|
19
|
+
The library is slightly modified (i.e. some internal headers and equivalent
|
20
|
+
symbols) production code used by Googlebot, Google's crawler, to determine which
|
21
|
+
URLs it may access based on rules provided by webmasters in robots.txt files.
|
22
|
+
The library is released open-source to help developers build tools that better
|
23
|
+
reflect Google's robots.txt parsing and matching.
|
24
|
+
|
25
|
+
For webmasters, we included a small binary in the project that allows testing a
|
26
|
+
single URL and user-agent against a robots.txt.
|
27
|
+
|
28
|
+
## Building the library
|
29
|
+
|
30
|
+
### Quickstart
|
31
|
+
|
32
|
+
We included with the library a small binary to test a local robots.txt against a
|
33
|
+
user-agent and URL. Running the included binary requires:
|
34
|
+
|
35
|
+
* A compatible platform (e.g. Windows, macOS, Linux, etc.). Most platforms are
|
36
|
+
fully supported.
|
37
|
+
* A compatible C++ compiler supporting at least C++11. Most major compilers
|
38
|
+
are supported.
|
39
|
+
* [Git](https://git-scm.com/) for interacting with the source code repository.
|
40
|
+
To install Git, consult the
|
41
|
+
[Set Up Git](https://help.github.com/articles/set-up-git/) guide on
|
42
|
+
[GitHub](https://github.com/).
|
43
|
+
* Although you are free to use your own build system, most of the
|
44
|
+
documentation within this guide will assume you are using
|
45
|
+
[Bazel](https://bazel.build/). To download and install Bazel (and any of its
|
46
|
+
dependencies), consult the
|
47
|
+
[Bazel Installation Guide](https://docs.bazel.build/versions/master/install.html)
|
48
|
+
|
49
|
+
#### Building with Bazel
|
50
|
+
|
51
|
+
[Bazel](https://bazel.build/) is the official build system for the library,
|
52
|
+
which is supported on most major platforms (Linux, Windows, MacOS, for example)
|
53
|
+
and compilers.
|
54
|
+
|
55
|
+
To build and run the binary:
|
56
|
+
|
57
|
+
```bash
|
58
|
+
$ git clone https://github.com/google/robotstxt.git robotstxt
|
59
|
+
Cloning into 'robotstxt'...
|
60
|
+
...
|
61
|
+
$ cd robotstxt/
|
62
|
+
bazel-robots$ bazel test :robots_test
|
63
|
+
...
|
64
|
+
/:robots_test PASSED in 0.1s
|
65
|
+
|
66
|
+
Executed 1 out of 1 test: 1 test passes.
|
67
|
+
...
|
68
|
+
bazel-robots$ bazel build :robots_main
|
69
|
+
...
|
70
|
+
Target //:robots_main up-to-date:
|
71
|
+
bazel-bin/robots_main
|
72
|
+
...
|
73
|
+
bazel-robots$ bazel run robots_main -- ~/local/path/to/robots.txt YourBot https://example.com/url
|
74
|
+
user-agent 'YourBot' with url 'https://example.com/url' allowed: YES
|
75
|
+
```
|
76
|
+
|
77
|
+
#### Building with CMake
|
78
|
+
|
79
|
+
[CMake](https://cmake.org) is the community-supported build system for the
|
80
|
+
library.
|
81
|
+
|
82
|
+
To build the library using CMake, just follow the steps below:
|
83
|
+
|
84
|
+
```bash
|
85
|
+
$ git clone https://github.com/google/robotstxt.git robotstxt
|
86
|
+
Cloning into 'robotstxt'...
|
87
|
+
...
|
88
|
+
$ cd robotstxt/
|
89
|
+
...
|
90
|
+
$ mkdir c-build && cd c-build
|
91
|
+
...
|
92
|
+
$ cmake .. -DROBOTS_BUILD_TESTS=ON
|
93
|
+
...
|
94
|
+
$ make
|
95
|
+
...
|
96
|
+
$ make test
|
97
|
+
Running tests...
|
98
|
+
Test project robotstxt/c-build
|
99
|
+
Start 1: robots-test
|
100
|
+
1/1 Test #1: robots-test ...................... Passed 0.02 sec
|
101
|
+
|
102
|
+
100% tests passed, 0 tests failed out of 1
|
103
|
+
|
104
|
+
Total Test time (real) = 0.02 sec
|
105
|
+
...
|
106
|
+
$ robots ~/local/path/to/robots.txt YourBot https://example.com/url
|
107
|
+
user-agent 'YourBot' with url 'https://example.com/url' allowed: YES
|
108
|
+
```
|
109
|
+
|
110
|
+
## Notes
|
111
|
+
|
112
|
+
Parsing of robots.txt files themselves is done exactly as in the production
|
113
|
+
version of Googlebot, including how percent codes and unicode characters in
|
114
|
+
patterns are handled. The user must ensure however that the URI passed to the
|
115
|
+
AllowedByRobots and OneAgentAllowedByRobots functions, or to the URI parameter
|
116
|
+
of the robots tool, follows the format specified by RFC3986, since this library
|
117
|
+
will not perform full normalization of those URI parameters. Only if the URI is
|
118
|
+
in this format, the matching will be done according to the REP specification.
|
119
|
+
|
120
|
+
## License
|
121
|
+
|
122
|
+
The robots.txt parser and matcher C++ library is licensed under the terms of the
|
123
|
+
Apache license. See LICENSE for more information.
|
124
|
+
|
125
|
+
## Links
|
126
|
+
|
127
|
+
To learn more about this project:
|
128
|
+
|
129
|
+
* check out the
|
130
|
+
[internet draft](https://tools.ietf.org/html/draft-koster-rep),
|
131
|
+
* how
|
132
|
+
[Google's handling robots.txt](https://developers.google.com/search/reference/robots_txt),
|
133
|
+
* or for a high level overview, the
|
134
|
+
[robots.txt page on Wikipedia](https://en.wikipedia.org/wiki/Robots_exclusion_standard).
|
@@ -0,0 +1,28 @@
|
|
1
|
+
workspace(name = "com_google_robotstxt")
|
2
|
+
|
3
|
+
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
|
4
|
+
|
5
|
+
http_archive(
|
6
|
+
name = "com_google_absl",
|
7
|
+
strip_prefix = "abseil-cpp-master",
|
8
|
+
urls = ["https://github.com/abseil/abseil-cpp/archive/master.zip"],
|
9
|
+
)
|
10
|
+
|
11
|
+
# GoogleTest/GoogleMock framework. Used by unit-tests.
|
12
|
+
http_archive(
|
13
|
+
name = "com_google_googletest",
|
14
|
+
sha256 = "ff7a82736e158c077e76188232eac77913a15dac0b22508c390ab3f88e6d6d86",
|
15
|
+
strip_prefix = "googletest-b6cd405286ed8635ece71c72f118e659f4ade3fb",
|
16
|
+
urls = ["https://github.com/google/googletest/archive/b6cd405286ed8635ece71c72f118e659f4ade3fb.zip"], # 2019-01-07
|
17
|
+
)
|
18
|
+
|
19
|
+
# C++ rules for Bazel.
|
20
|
+
http_archive(
|
21
|
+
name = "rules_cc",
|
22
|
+
sha256 = "67412176974bfce3f4cf8bdaff39784a72ed709fc58def599d1f68710b58d68b",
|
23
|
+
strip_prefix = "rules_cc-b7fe9697c0c76ab2fd431a891dbb9a6a32ed7c3e",
|
24
|
+
urls = [
|
25
|
+
"https://mirror.bazel.build/github.com/bazelbuild/rules_cc/archive/b7fe9697c0c76ab2fd431a891dbb9a6a32ed7c3e.zip",
|
26
|
+
"https://github.com/bazelbuild/rules_cc/archive/b7fe9697c0c76ab2fd431a891dbb9a6a32ed7c3e.zip",
|
27
|
+
],
|
28
|
+
)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Robots Exclusion Protocol Internet Draft (I-D)
|
2
|
+
|
3
|
+
The file in this directory is the working copy of the file submitted to IETF for
|
4
|
+
standardization.
|
5
|
+
|
6
|
+
It is published at https://tools.ietf.org/html/draft-koster-rep
|
7
|
+
|
8
|
+
**Do not edit files in this folder, we are not accepting reviews.** Instead, get
|
9
|
+
in touch with the authors.
|