├── .bumplus.toml
├── .circleci
└── config.yml
├── .editorconfig
├── .gitattributes
├── .github
├── stale.yml
└── workflows
│ └── ci.yml
├── .gitignore
├── .jscpd.json
├── .mega-linter.yml
├── Brewfile
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── Cask
├── Eldev
├── LICENSE
├── README.md
├── kics.config
├── mb-url-http.el
├── mb-url.el
├── renovate.json5
└── test
└── mb-url-test.el
/.bumplus.toml:
--------------------------------------------------------------------------------
1 | version = '0.12.0'
2 |
3 | [[files."CHANGELOG.md"]]
4 | search = '''
5 | ## [Unreleased] ##
6 | '''
7 | replace = '''
8 | ## [Unreleased] ##
9 |
10 | ## [{{new_version}}] - {{utcnow | strftime('%Y-%m-%d')}} ##
11 | '''
12 |
13 | [[files."CHANGELOG.md"]]
14 | search = '''
15 | [Unreleased]: https://github.com/dochang/mb-url/compare/{{old_version}}...HEAD
16 | '''
17 | replace = '''
18 | [Unreleased]: https://github.com/dochang/mb-url/compare/{{new_version}}...HEAD
19 | [{{new_version}}]: https://github.com/dochang/mb-url/compare/{{old_version}}...{{new_version}}
20 | '''
21 |
22 | [[files."mb-url.el"]]
23 | search = '{{old_version}}'
24 | replace = '{{new_version}}'
25 |
26 | [[files."README.md"]]
27 | search = '{{old_version}}'
28 | replace = '{{new_version}}'
29 |
30 | [[files."Cask"]]
31 | search = '{{old_version}}'
32 | replace = '{{new_version}}'
33 |
--------------------------------------------------------------------------------
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | version: 2.1
2 |
3 | jobs:
4 | MegaLinter:
5 | docker:
6 | - image: oxsecurity/megalinter:v8
7 | # checkov:skip=CKV_CIRCLECIPIPELINES_2:prefer mutable but stable tags
8 | steps:
9 | - checkout
10 | - run:
11 | name: Setup environment variables
12 | command: |
13 | echo "export CI_JOB_URL=$CIRCLE_BUILD_URL" >> "$BASH_ENV"
14 | # Export `CI_JOB_URL` for MegaLinter API Reporter
15 | echo "export DEFAULT_WORKSPACE=$CIRCLE_WORKING_DIRECTORY" >> "$BASH_ENV"
16 | . "$BASH_ENV"
17 | - run:
18 | name: Run MegaLinter
19 | command: |
20 | sh /entrypoint.sh
21 | - store_artifacts:
22 | path: megalinter-reports
23 | test:
24 | parameters:
25 | emacs-version:
26 | type: string
27 | docker:
28 | - image: silex/emacs:<< parameters.emacs-version >>-ci-eldev
29 | # checkov:skip=CKV_CIRCLECIPIPELINES_2:prefer mutable but stable tags
30 | - image: mccutchen/go-httpbin
31 | # checkov:skip=CKV_CIRCLECIPIPELINES_2:prefer mutable but stable tags
32 | steps:
33 | - checkout
34 | - run:
35 | name: Install homebrew
36 | command: |
37 | apt-get update && apt-get --yes install build-essential procps curl file git
38 | # https://github.com/orgs/Homebrew/discussions/3030
39 | bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
40 | environment:
41 | NONINTERACTIVE: 1
42 | - restore_cache:
43 | keys:
44 | - &eldev-cache-key v1-eldev-<< parameters.emacs-version >>-{{ checksum "Eldev" }}
45 | - v1-eldev-<< parameters.emacs-version >>-
46 | - v1-eldev-
47 | - run:
48 | name: Test
49 | command: |
50 | eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
51 | brew bundle install
52 | dockerize -wait "${MB_URL_TEST__MOCKAPI_PREFIX}" -timeout 60s
53 | # Waiting for mock server
54 | eldev lint
55 | eldev test
56 | environment:
57 | MB_URL_TEST__MOCKAPI_PREFIX: "http://localhost:8080"
58 | HOMEBREW_BUNDLE_NO_LOCK: 1
59 | no_output_timeout: 5m
60 | - save_cache:
61 | key: *eldev-cache-key
62 | paths:
63 | - "~/.cache/eldev"
64 |
65 | workflows:
66 | CI:
67 | jobs:
68 | - MegaLinter:
69 | context: megalinter
70 | - test:
71 | matrix:
72 | parameters:
73 | emacs-version:
74 | - "27.1"
75 | - "27.2"
76 | - "28.1"
77 | - "28.2"
78 | - "29.1"
79 | - "29.2"
80 | - "29.3"
81 | - "29.4"
82 | - "30.1"
83 | context: test
84 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | charset = utf-8
5 | insert_final_newline = true
6 | end_of_line = lf
7 |
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | * text=auto eol=lf
2 |
--------------------------------------------------------------------------------
/.github/stale.yml:
--------------------------------------------------------------------------------
1 | # Configuration for probot-stale - https://github.com/probot/stale
2 |
3 | # Number of days of inactivity before an issue becomes stale
4 | daysUntilStale: 60
5 |
6 | # Number of days of inactivity before a stale issue is closed
7 | daysUntilClose: 7
8 |
9 | # Issues with these labels will never be considered stale
10 | exemptLabels:
11 | - pinned
12 | - security
13 |
14 | # Label to use when marking an issue as stale
15 | staleLabel: stale
16 |
17 | # Comment to post when marking an issue as stale. Set to `false` to disable
18 | markComment: >
19 | This issue has been automatically marked as stale because it has not had
20 | recent activity. It will be closed if no further activity occurs. Thank you
21 | for your contributions.
22 |
23 | # Comment to post when closing a stale issue. Set to `false` to disable
24 | closeComment: false
25 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 | on:
3 | push:
4 | pull_request:
5 | branches:
6 | - main
7 | - master
8 | permissions: read-all
9 | jobs:
10 | MegaLinter:
11 | runs-on: ubuntu-latest
12 | permissions:
13 | issues: write
14 | pull-requests: write
15 | # For GitHub Comment Reporter
16 | # https://megalinter.io/latest/reporters/GitHubCommentReporter/
17 | steps:
18 | - uses: actions/checkout@v4
19 |
20 | # MegaLinter
21 | - name: MegaLinter
22 | id: ml
23 | # You can override MegaLinter flavor used to have faster performances
24 | # More info at https://megalinter.io/flavors/
25 | uses: oxsecurity/megalinter@v8
26 | env:
27 | # All available variables are described in documentation
28 | # https://megalinter.io/config-file/
29 | VALIDATE_ALL_CODEBASE: true
30 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
31 | # https://megalinter.io/latest/reporters/ApiReporter/
32 | API_REPORTER: true
33 | API_REPORTER_URL: ${{ secrets.API_REPORTER_URL }}
34 | API_REPORTER_BASIC_AUTH_USERNAME: ${{ secrets.API_REPORTER_BASIC_AUTH_USERNAME }}
35 | API_REPORTER_BASIC_AUTH_PASSWORD: ${{ secrets.API_REPORTER_BASIC_AUTH_PASSWORD }}
36 | API_REPORTER_METRICS_URL: ${{ secrets.API_REPORTER_METRICS_URL }}
37 | API_REPORTER_METRICS_BASIC_AUTH_USERNAME: ${{ secrets.API_REPORTER_METRICS_BASIC_AUTH_USERNAME }}
38 | API_REPORTER_METRICS_BASIC_AUTH_PASSWORD: ${{ secrets.API_REPORTER_METRICS_BASIC_AUTH_PASSWORD }}
39 | API_REPORTER_DEBUG: false
40 |
41 | # Upload MegaLinter artifacts
42 | - name: Archive production artifacts
43 | if: success() || failure()
44 | uses: actions/upload-artifact@v4
45 | with:
46 | name: MegaLinter reports
47 | path: |
48 | megalinter-reports
49 | mega-linter.log
50 |
51 | test:
52 | runs-on: ubuntu-latest
53 | services:
54 | mock-server:
55 | image: mccutchen/go-httpbin
56 | ports:
57 | - "8080"
58 | strategy:
59 | fail-fast: false
60 | matrix:
61 | emacs-version:
62 | - "27.1"
63 | - "27.2"
64 | - "28.1"
65 | - "28.2"
66 | - "29.1"
67 | - "29.2"
68 | - "29.3"
69 | - "29.4"
70 | - "30.1"
71 | steps:
72 | - uses: actions/checkout@v4
73 |
74 | - name: Set up Homebrew
75 | id: set-up-homebrew
76 | uses: Homebrew/actions/setup-homebrew@master
77 |
78 | - name: Set up Emacs
79 | uses: purcell/setup-emacs@master
80 | with:
81 | version: ${{ matrix.emacs-version }}
82 |
83 | - name: Install Eldev
84 | run: |
85 | brew install curl
86 | curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh
87 |
88 | - name: Cache eldev
89 | uses: actions/cache@v4
90 | with:
91 | path: ~/.cache/eldev
92 | key: v1-eldev-${{ matrix.emacs-version }}-${{ hashFiles('Eldev') }}
93 | restore-keys: |
94 | v1-eldev-${{ matrix.emacs-version }}-
95 | v1-eldev-
96 |
97 | - name: Test
98 | run: |
99 | brew bundle install
100 | dockerize -wait "${MB_URL_TEST__MOCKAPI_PREFIX}" -timeout 60s
101 | # Waiting for mock server
102 | eldev lint
103 | eldev test
104 | env:
105 | MB_URL_TEST__MOCKAPI_PREFIX: "http://localhost:${{ job.services.mock-server.ports['8080'] }}"
106 | HOMEBREW_BUNDLE_NO_LOCK: 1
107 | timeout-minutes: 5
108 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Created by https://www.gitignore.io/api/emacs
2 |
3 | ### Emacs ###
4 | # -*- mode: gitignore; -*-
5 | *~
6 | \#*\#
7 | /.emacs.desktop
8 | /.emacs.desktop.lock
9 | *.elc
10 | auto-save-list
11 | tramp
12 | .\#*
13 |
14 | # Org-mode
15 | .org-id-locations
16 | *_archive
17 |
18 | # flymake-mode
19 | *_flymake.*
20 |
21 | # eshell files
22 | /eshell/history
23 | /eshell/lastdir
24 |
25 | # elpa packages
26 | /elpa/
27 |
28 | # reftex files
29 | *.rel
30 |
31 | # AUCTeX auto folder
32 | /auto/
33 |
34 | # cask packages
35 | .cask/
36 |
37 | # Added automatically by ‘eldev init’.
38 | /.eldev
39 | /Eldev-local
40 |
41 | megalinter-reports/
42 |
--------------------------------------------------------------------------------
/.jscpd.json:
--------------------------------------------------------------------------------
1 | {
2 | "ignore": ["test/**"]
3 | }
4 |
--------------------------------------------------------------------------------
/.mega-linter.yml:
--------------------------------------------------------------------------------
1 | APPLY_FIXES: none
2 | SHOW_ELAPSED_TIME: true
3 | IGNORE_GITIGNORED_FILES: true
4 | DISABLE:
5 | - SPELL
6 | FILEIO_REPORTER: true
7 | DISABLE_LINTERS:
8 | - REPOSITORY_DEVSKIM
9 | REPOSITORY_DEVSKIM_ARGUMENTS: --ignore-globs .github/workflows/ci.yml
10 | # We use internal container to serve http mock server and we are unable to
11 | # exclude all CI files which contain `http://localhost` because of the
12 | # following error:
13 | #
14 | # Specify --help for a list of available options and commands.
15 | # Unhandled exception. Microsoft.Extensions.CommandLineUtils.CommandParsingException: Unexpected value '**/megalinter-reports/**' for option 'ignore-globs'
16 | # at Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Execute(String[] args)
17 | # at Microsoft.DevSkim.CLI.Program.Main(String[] args) in D:\a\1\s\DevSkim-DotNet\Microsoft.DevSkim.CLI\Program.cs:line 14
18 | #
19 | # So just disable DevSkim.
20 |
--------------------------------------------------------------------------------
/Brewfile:
--------------------------------------------------------------------------------
1 | brew "curl"
2 | brew "httpie"
3 | brew "dockerize"
4 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Change Log
2 |
3 | ## [Unreleased]
4 |
5 | ### Added
6 |
7 | - Test for Emacs 29.2..30.1
8 |
9 | ### Changed
10 |
11 | - Require all HTTP clients to automatically decompress response bodies
12 | - Simplify Curl sentinel
13 | - Refactor test code
14 |
15 | ### Removed
16 |
17 | - Support for Emacs 25 and 26
18 |
19 | ## [0.12.0] - 2023-08-11
20 |
21 | ### Added
22 |
23 | - CircleCI configuration
24 | - CircleCI badge
25 | - Deps cache
26 | - Test for Emacs 29.1
27 |
28 | ### Changed
29 |
30 | - Switch CI dependency management to Homebrew
31 | - Upgrade to MegaLinter v7
32 | - Replace httpbin with httpbingo
33 |
34 | ### Removed
35 |
36 | - Unused badges
37 |
38 | ### Fixed
39 |
40 | - I18N test
41 |
42 | ## [0.11.0] - 2022-12-01
43 |
44 | ### Added
45 |
46 | - Test for Emacs 28.2
47 |
48 | ### Changed
49 |
50 | - Upgrade to MegaLinter v6
51 | - Upgrade Github actions
52 |
53 | ### Fixed
54 |
55 | - Lint errors
56 |
57 | ### Removed
58 |
59 | - Drone CI configuration
60 |
61 | ## [0.10.0] - 2022-09-21
62 |
63 | ### Added
64 |
65 | - Test for Emacs 28.1
66 | - HTTPie sentinel
67 | - Custom variables for deleting HTTPie supported content encodings
68 | - Test cases for url-http variables
69 |
70 | ### Changed
71 |
72 | - Run GitHub Actions on pull_request
73 | - Modularize sentinels
74 |
75 | ### Fixed
76 |
77 | - Replace `cl` with `cl-lib`
78 | - Edit process buffer in place to avoid multibyte flag resetting
79 | - Allow binding `url-mime-accept-string`
80 | - Respect `url-request-noninteractive`
81 | - Support `url-http-referer`
82 | - Send extra headers based on Emacs variables
83 | - Remove internal headers for HTTPie from headers
84 |
85 | ## [0.9.0] - 2021-12-05
86 |
87 | ### Changed
88 |
89 | - Migrate MegaLinter to v5
90 |
91 | ## [0.8.0] - 2021-10-29
92 |
93 | ### Added
94 |
95 | - Allow the process displays the error messages in a buffer
96 |
97 | ### Changed
98 |
99 | - Create process by `make-process` instead of `start-process`
100 | - Use lexical binding for the whole project
101 | - Make backends always wait for stdin
102 | - Make url retrieval buffers single-byte before executing callback
103 |
104 | ### Removed
105 |
106 | - Emacs 24 support
107 |
108 | ## [0.7.0] - 2021-10-13
109 |
110 | ### Added
111 |
112 | - Data types for user options
113 | - Support parsing HTTP messages which use LF (`\n`) as line delimiter
114 |
115 | ## [0.6.1] - 2021-09-17
116 |
117 | ### Fixed
118 |
119 | - HTTP response body processing in sentinel
120 |
121 | ## [0.6.0] - 2021-09-16
122 |
123 | ### Added
124 |
125 | - Lint project by Mega-Linter
126 | - Test case for Emacs 27
127 | - GitHub Actions workflow
128 | - GitHub Actions badge
129 |
130 | ### Changed
131 |
132 | - Replace Cask with Eldev
133 |
134 | ### Removed
135 |
136 | - Drop test cases for non-latest images of each major version
137 | - Drop Linuxbrew use in CI
138 |
139 | ## [0.5.1] - 2019-10-06
140 |
141 | ### Added
142 |
143 | - Add badges
144 |
145 | ## [0.5.0] - 2019-09-21
146 |
147 | ### Changed
148 |
149 | - Replace test helpers with environment variable
150 | - Migrate from Travis to Drone
151 | - Test for Emacs 26
152 |
153 | ## [0.4.0] - 2018-12-25
154 |
155 | ### Added
156 |
157 | - `mb-url-http-curl-switches`
158 | - `mb-url-http-httpie-switches`
159 | - Add badges
160 |
161 | ### Changed
162 |
163 | - Use ert-runner to test
164 | - Fallback to `url-http` only if `mb-url-http-backend` is nil
165 | - Add more test cases
166 | - Rename variables to follow Emacs conventions
167 |
168 | ### Deprecated
169 |
170 | - Not recommended since Emacs 26
171 |
172 | ## [0.3.1] - 2018-10-11
173 |
174 | ### Changed
175 |
176 | - Support set empty headers
177 | - Support unset headers
178 |
179 | ## [0.3.0] - 2018-09-27
180 |
181 | ### Changed
182 |
183 | - Completely rewrite for url-http backends
184 | - New test code
185 |
186 | ## [0.2.1] - 2018-09-07
187 |
188 | ### Changed
189 |
190 | - Make ERT easy to debug
191 |
192 | ## [0.2.0] - 2018-09-01
193 |
194 | ### Fixed
195 |
196 | - Do not post data for curl even if the data is an empty string
197 |
198 | ## [0.1.0] - 2016-12-25
199 |
200 | ### Added
201 |
202 | - Test for Emacs 25.1
203 |
204 | ### Changed
205 |
206 | - Naming convention
207 | - Rewrite test code
208 |
209 | ### Fixed
210 |
211 | - Fix for Emacs 25
212 |
213 | ## [0.0.9] - 2016-07-24
214 |
215 | ### Added
216 |
217 | - Add code of conduct
218 |
219 | ## [0.0.8] - 2016-07-01
220 |
221 | ### Added
222 |
223 | - Test on travis-ci
224 |
225 | ## [0.0.7] - 2016-06-02
226 |
227 | ### Added
228 |
229 | - Add bumplus config
230 |
231 | ## [0.0.6] - 2016-05-08
232 |
233 | ### Fixed
234 |
235 | - Fix version number.
236 |
237 | ## [0.0.5] - 2016-04-14
238 |
239 | ### Changed
240 |
241 | - Fix typo in the change log.
242 |
243 | ## [0.0.4] - 2016-04-14
244 |
245 | ### Changed
246 |
247 | - Fix typo in the change log.
248 |
249 | ### Added
250 |
251 | - Add links to MELPA & el-get.
252 |
253 | ## [0.0.3] - 2015-12-10
254 |
255 | ### Changed
256 |
257 | - Improve the change log format.
258 |
259 | ### Added
260 |
261 | - Add tag comparison links in the change log.
262 | - Add install instruction
263 |
264 | ## [0.0.2] - 2015-12-06
265 |
266 | ### Fixed
267 |
268 | - Fix typo
269 |
270 | ## [0.0.1] - 2015-12-03
271 |
272 | ### Added
273 |
274 | - Initial release
275 |
276 |
277 |
278 |
280 |
281 | [Unreleased]: https://github.com/dochang/mb-url/compare/0.12.0...HEAD
282 | [0.12.0]: https://github.com/dochang/mb-url/compare/0.11.0...0.12.0
283 | [0.11.0]: https://github.com/dochang/mb-url/compare/0.10.0...0.11.0
284 | [0.10.0]: https://github.com/dochang/mb-url/compare/0.9.0...0.10.0
285 | [0.9.0]: https://github.com/dochang/mb-url/compare/0.8.0...0.9.0
286 | [0.8.0]: https://github.com/dochang/mb-url/compare/0.7.0...0.8.0
287 | [0.7.0]: https://github.com/dochang/mb-url/compare/0.6.1...0.7.0
288 | [0.6.1]: https://github.com/dochang/mb-url/compare/0.6.0...0.6.1
289 | [0.6.0]: https://github.com/dochang/mb-url/compare/0.5.1...0.6.0
290 | [0.5.1]: https://github.com/dochang/mb-url/compare/0.5.0...0.5.1
291 | [0.5.0]: https://github.com/dochang/mb-url/compare/0.4.0...0.5.0
292 | [0.4.0]: https://github.com/dochang/mb-url/compare/0.3.1...0.4.0
293 | [0.3.1]: https://github.com/dochang/mb-url/compare/0.3.0...0.3.1
294 | [0.3.0]: https://github.com/dochang/mb-url/compare/0.2.1...0.3.0
295 | [0.2.1]: https://github.com/dochang/mb-url/compare/0.2.0...0.2.1
296 | [0.2.0]: https://github.com/dochang/mb-url/compare/0.1.0...0.2.0
297 | [0.1.0]: https://github.com/dochang/mb-url/compare/0.0.9...0.1.0
298 | [0.0.9]: https://github.com/dochang/mb-url/compare/0.0.8...0.0.9
299 | [0.0.8]: https://github.com/dochang/mb-url/compare/0.0.7...0.0.8
300 | [0.0.7]: https://github.com/dochang/mb-url/compare/0.0.6...0.0.7
301 | [0.0.6]: https://github.com/dochang/mb-url/compare/0.0.5...0.0.6
302 | [0.0.5]: https://github.com/dochang/mb-url/compare/0.0.4...0.0.5
303 | [0.0.4]: https://github.com/dochang/mb-url/compare/0.0.3...0.0.4
304 | [0.0.3]: https://github.com/dochang/mb-url/compare/0.0.2...0.0.3
305 | [0.0.2]: https://github.com/dochang/mb-url/compare/0.0.1...0.0.2
306 | [0.0.1]: https://github.com/dochang/mb-url/commits/0.0.1
307 |
308 |
309 |
310 |
317 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, gender identity and expression, level of experience,
9 | nationality, personal appearance, race, religion, or sexual identity and
10 | orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at [http://contributor-covenant.org/version/1/4][version]
72 |
73 | [homepage]: http://contributor-covenant.org
74 | [version]: http://contributor-covenant.org/version/1/4/
75 |
--------------------------------------------------------------------------------
/Cask:
--------------------------------------------------------------------------------
1 | (source gnu)
2 | (source melpa)
3 |
4 | (package "mb-url" "0.12.0" "Multiple backends for URL package.")
5 |
6 | (depends-on "cl-lib")
7 |
8 | (development
9 | (depends-on "s")
10 | (depends-on "ert-runner"))
11 |
--------------------------------------------------------------------------------
/Eldev:
--------------------------------------------------------------------------------
1 | ;; -*- mode: emacs-lisp; lexical-binding: t -*-
2 |
3 | ;; Uncomment some calls below as needed for your project.
4 | (eldev-use-package-archive 'gnu)
5 | (eldev-use-package-archive 'melpa)
6 |
7 | ;; (eldev-use-plugin 'autoloads)
8 | ;; Do not generate *-autoloads.el. Comment it.
9 |
10 | (eldev-add-extra-dependencies
11 | 'test
12 | 's)
13 |
14 | (setq eldev-lint-disabled '(package))
15 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # mb-url - Multiple Backends for Emacs URL package
2 |
3 | *Author:* ZHANG Weiyi
4 | *Version:* 0.12.0
5 | *URL:* [https://github.com/dochang/mb-url](https://github.com/dochang/mb-url)
6 |
7 |
8 | [](http://melpa.org/#/mb-url)
9 | [](http://stable.melpa.org/#/mb-url)
10 | [](https://github.com/dochang/mb-url/actions/workflows/ci.yml)
11 | [](https://dl.circleci.com/status-badge/redirect/gh/dochang/mb-url/tree/master)
12 | [](http://isitmaintained.com/project/dochang/mb-url "Average time to resolve an issue")
13 | [](http://isitmaintained.com/project/dochang/mb-url "Percentage of issues still open")
14 | [](https://github.com/dochang/mb-url)
15 | [](https://github.com/dochang/mb-url)
16 | [](https://github.com/dochang/mb-url/blob/master/LICENSE)
17 | [](https://saythanks.io/to/dochang)
18 |
24 |
25 |
26 | Multiple Backends for URL package.
27 |
28 | This package provides several backends for `url-retrieve` &
29 | `url-retrieve-synchronously`, which replace the internal implementation.
30 |
31 | The motivation of this package is I can't connect HTTPS url behind proxy
32 | (Related bugs: [#11788][], [#12636][], [#18860][], [msg00756][], [#10][]).
33 |
34 | [#11788]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11788
35 | [#12636]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=12636
36 | [#18860]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18860
37 | [msg00756]: https://lists.gnu.org/archive/html/help-gnu-emacs/2015-08/msg00756.html
38 | [#10]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=10
39 |
40 | ## Notice
41 |
42 | As the URL package has supported HTTPS over proxies supporting CONNECT since
43 | Emacs 26, this package is no longer recommended. But it can still be used
44 | in Emacs 26+.
45 |
46 | ## Installation
47 |
48 | `mb-url` is available on [MELPA] and [el-get].
49 |
50 | [MELPA]: https://melpa.org/
51 | [el-get]: https://github.com/dimitri/el-get
52 |
53 | To install `mb-url` from git repository, clone the repo, then add the repo
54 | dir into `load-path`.
55 |
56 | `mb-url` depends on `cl-lib`; The test code also depends on `s`.
57 |
58 | ## Backends
59 |
60 | Currently only support `url-http`.
61 |
62 | ### `url-http`
63 |
64 | Install `mb-url-http-around-advice` to use `mb-url-http` backends.
65 |
66 | ```elisp
67 | (advice-add 'url-http :around 'mb-url-http-around-advice)
68 | ```
69 |
70 | All backend functions receive `(name url buffer default-sentinel)`, return a
71 | process.
72 |
73 | `mb-url-http-backend` indicates the current backend. If the backend is
74 | `nil`, which means no backend, `url-http` will be called.
75 |
76 | E.g.,
77 |
78 | ```elisp
79 | (setq mb-url-http-backend 'mb-url-http-curl)
80 | ```
81 |
82 | NOTE: All clients are required to support automatically decompressing
83 | response bodies.
84 |
85 | #### [cURL][]
86 |
87 | [cURL]: http://curl.haxx.se/
88 |
89 | ##### `mb-url-http-curl`
90 |
91 | cURL backend for `url-http`.
92 |
93 | ##### `mb-url-http-curl-program`
94 |
95 | cURL program.
96 |
97 | ##### `mb-url-http-curl-switches`
98 |
99 | cURL switches.
100 |
101 | #### [HTTPie][]
102 |
103 | [HTTPie]: http://httpie.org/
104 |
105 | ##### `mb-url-http-httpie`
106 |
107 | HTTPie backend for `url-http`.
108 |
109 | ##### `mb-url-http-httpie-program`
110 |
111 | HTTPie program.
112 |
113 | ##### `mb-url-http-httpie-switches`
114 |
115 | HTTPie switches.
116 |
117 | ##### `mb-url-http-httpie-supported-content-encoding-list`
118 |
119 | Content encodings which HTTPie supports to decode.
120 |
121 | If your HTTPie supports to decode a encoding like `br`, put the encoding
122 | into this list.
123 |
124 | By default, HTTPie supports to decode `gzip` and `deflate`.
125 |
126 | ##### `mb-url-http-httpie-content-encoding-fix-function`
127 |
128 | A function to fix the value of `Content-Encoding` for HTTPie. Default
129 | value is `mb-url-http-httpie-delete-content-encoding-from-list`.
130 |
131 | ## License
132 |
133 | GPLv3
134 |
135 | ## Acknowledgements
136 |
137 |
138 |
139 |
140 | ---
141 | Converted from `mb-url.el` by [*el2markdown*](https://github.com/Lindydancer/el2markdown).
142 |
--------------------------------------------------------------------------------
/kics.config:
--------------------------------------------------------------------------------
1 | # -*- mode: toml; -*-
2 |
3 | # https://megalinter.io/latest/descriptors/repository_kics/
4 | # https://docs.kics.io/latest/configuration-file/
5 | # https://docs.kics.io/latest/commands/#scan-command-options
6 |
7 | exclude-queries = [
8 | "555ab8f9-2001-455e-a077-f2d0f41e2fb9",
9 | # https://docs.kics.io/latest/queries/cicd-queries/common/555ab8f9-2001-455e-a077-f2d0f41e2fb9/
10 | ]
11 |
--------------------------------------------------------------------------------
/mb-url-http.el:
--------------------------------------------------------------------------------
1 | ;;; mb-url-http.el --- Backends for `url-http' -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2015, 2016, 2018, 2021, 2022 ZHANG Weiyi
4 |
5 | ;; Author: ZHANG Weiyi
6 | ;; Keywords: comm, data, processes
7 |
8 | ;; This file is not part of GNU Emacs.
9 |
10 | ;;; License:
11 |
12 | ;; This program is free software: you can redistribute it and/or modify it
13 | ;; under the terms of the GNU General Public License as published by the Free
14 | ;; Software Foundation, either version 3 of the License, or (at your option)
15 | ;; any later version.
16 |
17 | ;; This program is distributed in the hope that it will be useful, but WITHOUT
18 | ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 | ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 | ;; more details.
21 |
22 | ;; You should have received a copy of the GNU General Public License along with
23 | ;; this program. If not, see .
24 |
25 | ;;; Commentary:
26 |
27 | ;; Backends for `url-http'.
28 |
29 | ;;; Code:
30 |
31 | (require 'cl-lib)
32 | (require 'url-http)
33 |
34 | (require 'mb-url)
35 |
36 | (defcustom mb-url-http-backend nil
37 | "Backend for `url-http'."
38 | :type '(choice (function :tag "curl" mb-url-http-curl)
39 | (function :tag "httpie" mb-url-http-httpie)
40 | (const :tag "None" nil))
41 | :group 'mb-url)
42 |
43 | ;; TODO Add test code
44 | (defcustom mb-url-http-stderr nil
45 | "Where the process writes the standard error to.
46 |
47 | nil means the process writes the standard error to the \"*Messages*\" buffer.
48 |
49 | t means mb-url creates a new buffer for every process.
50 |
51 | A string means the process writes the standard error to the buffer named by the
52 | string (create if not exists).
53 |
54 | A function means the process writes the standard error to the return value of
55 | that function. The function must return a buffer, a pipe process or a
56 | string (buffer name)."
57 | :type '(choice (const :tag "The \"*Messages*\" buffer" nil)
58 | (const :tag "Create new buffer every time" t)
59 | (string :tag "Buffer Name")
60 | (symbol :tag "Function name")
61 | (function :tag "Function"))
62 | :group 'mb-url)
63 |
64 | (defun mb-url-http--goto-next-body ()
65 | "Goto next part of body."
66 | (re-search-forward "^\r?\n"))
67 |
68 | (defun mb-url-http--delete-proxy-response ()
69 | "Delete the response message returned by proxy.
70 |
71 | Some proxies return a message like this:
72 |
73 | HTTP/1.1 200 Connection established
74 | Proxy-Header: foo
75 | ...
76 |
77 | HTTP/1.1 200 OK
78 | Header: bar
79 | ...
80 |
81 | body...
82 |
83 | This function deletes the first block (from proxy)."
84 | ;; [RFC draft][1] & [Privoxy code][2] use "Connection established". But
85 | ;; [polipo][] & [cow][] use "Tunnel established". I use `[^\r\n]` here for
86 | ;; compatibility.
87 | ;;
88 | ;; [1]: https://tools.ietf.org/html/draft-luotonen-web-proxy-tunneling-01#section-3.2
89 | ;; [2]: http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/jcc.c?view=markup
90 | ;; [polipo]: https://github.com/jech/polipo/blob/master/tunnel.c#L302
91 | ;; [cow]: https://github.com/cyfdecyf/cow/blob/master/proxy.go#L1160
92 | (goto-char (point-min))
93 | (when (looking-at-p "HTTP/[0-9]+\\.[0-9]+ 2[0-9][0-9] [^\r\n]* established\r?\n")
94 | (delete-region (point) (progn (mb-url-http--goto-next-body) (point)))))
95 |
96 | (defun mb-url-http--delete-carriage-return ()
97 | "Delete carriage return from the header part."
98 | (save-excursion
99 | (mb-url-http--reset-end-of-headers)
100 | (url-http-clean-headers)))
101 |
102 | (defun mb-url-http--fix-header (header fix-function &optional last all list)
103 | "Fix all HEADER lines from response message.
104 |
105 | FIX-FUNCTION should be a function of one argument. It is called with header
106 | values as its argument and returns the new value of HEADER. If it returns a
107 | string, the value of HEADER will be replaced with the string. If it returns
108 | nil, all HEADER lines will be removed. If it returns t, all HEADER lines
109 | keeps unchanged.
110 |
111 | LAST, ALL, LIST will be passed to `mail-fetch-field'."
112 | (save-excursion
113 | (save-restriction
114 | (goto-char (point-min))
115 | (and (not (buffer-narrowed-p))
116 | (mail-narrow-to-head))
117 | (goto-char (point-min))
118 | (let* ((hvals (mail-fetch-field header last all list nil))
119 | (fixed (funcall fix-function hvals)))
120 | (cond ((eq fixed t))
121 | ((null fixed)
122 | (goto-char (point-min))
123 | (mail-fetch-field header last all list t)
124 | (flush-lines "^[ \t]*$" (point-min) (point-max)))
125 | (t
126 | (goto-char (point-min))
127 | (mail-fetch-field header last all list t)
128 | (flush-lines "^[ \t]*$" (point-min) (point-max))
129 | (goto-char (point-max))
130 | (insert (concat header ": " fixed "\n"))))))))
131 |
132 | (defun mb-url-http--delete-content-encoding ()
133 | "Delete \"Content-Encoding\" from headers.
134 |
135 | Starting from Emacs 27, if `Content-Encoding' is `gzip' and Emacs
136 | has zlib support, `url-handle-content-transfer-encoding', which
137 | is called by `url-http-parse-headers', will decompress response
138 | bodies and will delete `Content-Encoding' from headers.
139 |
140 | External HTTP clients automatically decompress response bodies
141 | but keep `Content-Encoding' undeleted. This confuses
142 | `url-handle-content-transfer-encoding' and `url-store-in-cache'.
143 | Delete `Content-Encoding' manually."
144 | ;; [1]: https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=e310843d9dc106187d0e45ef7f0b9cd90a881eec
145 | ;; [2]: https://github.com/emacs-mirror/emacs/commit/e310843d9dc106187d0e45ef7f0b9cd90a881eec
146 | ;; [3]: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=36773
147 | (save-excursion
148 | (goto-char (point-min))
149 | (let ((end-of-headers (re-search-forward "\n\n" nil t))
150 | (case-fold-search t))
151 | (save-restriction
152 | (narrow-to-region (point-min) end-of-headers)
153 | (goto-char (point-min))
154 | (while (re-search-forward "Content-Encoding: .*\n" nil t)
155 | (replace-match ""))))))
156 |
157 | (defun mb-url-http--reset-end-of-headers ()
158 | "Reset url-http-end-of-headers."
159 | (save-excursion
160 | (goto-char (point-min))
161 | (when (re-search-forward "^\r?\n" nil t)
162 | (backward-char 1)
163 | (set-marker (if (and (boundp 'url-http-end-of-headers)
164 | (markerp url-http-end-of-headers))
165 | url-http-end-of-headers
166 | (setq url-http-end-of-headers (make-marker)))
167 | (point)))))
168 |
169 | (defun mb-url-http-sentinel (proc evt)
170 | "Sentinel used to fix built-in sentinel.
171 |
172 | PROC is the process.
173 |
174 | EVT describes the type of event."
175 | (when (string= evt "finished\n")
176 | (with-current-buffer (process-buffer proc)
177 | (mb-url-http--delete-carriage-return)
178 | (mb-url-http--delete-content-encoding)
179 | (mb-url-http--reset-end-of-headers)
180 | (goto-char (point-min))
181 | (url-http-end-of-document-sentinel proc evt))))
182 |
183 | (defun mb-url-http-header-field-to-argument (header)
184 | "Convert HEADER to command line arguments."
185 | (let ((name (car header))
186 | (value (cdr header)))
187 | (cond ((null value)
188 | (format "%s:" name))
189 | ((string-match-p "\\`[ \t\n\r]*\\'" value)
190 | (format "%s;" name))
191 | (t
192 | (format "%s:%s" name value)))))
193 |
194 | (defun mb-url-http-extra-headers (url)
195 | "Get extra HTTP headers for URL."
196 | (let ((no-cache (cdr-safe (assoc "Pragma" url-request-extra-headers)))
197 | (proxy-auth (if (or (cdr-safe (assoc "Proxy-Authorization" url-request-extra-headers))
198 | (not url-using-proxy))
199 | nil
200 | (let ((url-basic-auth-storage 'url-http-proxy-basic-auth-storage))
201 | (url-get-authentication url-using-proxy nil 'any nil))))
202 | (real-fname (url-filename url))
203 | (host (url-host url))
204 | (auth (if (cdr-safe (assoc "Authorization" url-request-extra-headers))
205 | nil
206 | (url-get-authentication (or (and (boundp 'proxy-info)
207 | proxy-info)
208 | url) nil 'any nil)))
209 | (ref-url (and (fboundp 'url-http--get-referer)
210 | (url-http--encode-string (url-http--get-referer url)))))
211 | (if (equal "" real-fname)
212 | (setq real-fname "/"))
213 | (setq no-cache (and no-cache (string-match "no-cache" no-cache)))
214 | (append
215 | (seq-filter (lambda (header)
216 | (and (not (assoc-string (car header) url-request-extra-headers t))
217 | (cdr header)))
218 | (list
219 | (cons "From" url-personal-mail-address)
220 | (cons "Accept-Encoding" url-mime-encoding-string)
221 | (cons "Accept-Charset" (and url-mime-charset-string
222 | (url-http--encode-string url-mime-charset-string)))
223 | (cons "Accept-Language" url-mime-language-string)
224 | (cons "Accept" (or url-mime-accept-string "*/*"))
225 | (cons "Proxy-Authorization" proxy-auth)
226 | (cons "Authorization" auth)
227 | (cons "If-Modified-Since" (and (not no-cache)
228 | (member url-request-method '("GET" nil))
229 | (let ((tm (url-is-cached url)))
230 | (and tm
231 | (url-get-normalized-date tm)))))
232 | (cons "Referer" ref-url)
233 | (cons "Content-Length" (and url-request-data
234 | (number-to-string
235 | (string-bytes url-request-data))))))
236 | (when (and (url-use-cookies url)
237 | (assoc-string "Cookie" url-request-extra-headers t))
238 | (mapcar (lambda (line)
239 | (with-temp-buffer
240 | (insert line)
241 | (goto-char (point-min))
242 | (search-forward "Cookie: ")
243 | (replace-match "")
244 | (cons "Cookie" (buffer-string))))
245 | (split-string
246 | (url-http--encode-string
247 | (url-cookie-generate-header-lines
248 | host real-fname
249 | (equal "https" (url-type url))))
250 | "\r\n"
251 | t)))
252 | url-request-extra-headers)))
253 |
254 | (defun mb-url-http-process-send-url-request-data (proc)
255 | "Send request data, in binary form, to PROC."
256 | (unless (mb-url-string-empty-p url-request-data)
257 | (set-process-coding-system proc 'binary 'binary)
258 | (process-send-string proc url-request-data))
259 | (process-send-eof proc)
260 | proc)
261 |
262 | (defun mb-url-http--generate-name (url)
263 | "Generate process name based on URL."
264 | (format "*mb-url-http-%s-%s" url-request-method (url-recreate-url url)))
265 |
266 | ;;;###autoload
267 | (defun mb-url-http (url callback cbargs &optional retry-buffer gateway-method)
268 | "Retrieve URL via `mb-url-http-backend'.
269 |
270 | URL, CALLBACK, CBARGS, RETRY-BUFFER and GATEWAY-METHOD are the same arguments
271 | of `url-http'."
272 | (let* ((url-request-method (or url-request-method "GET"))
273 | (name (mb-url-http--generate-name url))
274 | (buf (generate-new-buffer name))
275 | (mime-accept-string url-mime-accept-string)
276 | (nsm-noninteractive (or url-request-noninteractive
277 | (and (boundp 'url-http-noninteractive)
278 | url-http-noninteractive)))
279 | (referer (and (fboundp 'url-http--get-referer)
280 | (url-http--encode-string (url-http--get-referer url))))
281 | (proc (funcall mb-url-http-backend
282 | name url buf #'mb-url-http-sentinel)))
283 | ;; stuff ripped out of url-http
284 | (with-current-buffer buf
285 | (mm-disable-multibyte)
286 | (setq url-current-object url
287 | mode-line-format "%b [%s]")
288 | (dolist (var '(url-http-end-of-headers
289 | url-http-content-type
290 | url-http-content-length
291 | url-http-transfer-encoding
292 | url-http-after-change-function
293 | url-http-response-version
294 | url-http-response-status
295 | url-http-chunked-length
296 | url-http-chunked-counter
297 | url-http-chunked-start
298 | url-callback-function
299 | url-callback-arguments
300 | url-show-status
301 | url-http-process
302 | url-http-method
303 | url-http-extra-headers
304 | url-http-noninteractive
305 | url-http-data
306 | url-http-target-url
307 | url-http-no-retry
308 | url-http-connection-opened
309 | url-mime-accept-string
310 | url-http-proxy
311 | url-http-referer))
312 | (set (make-local-variable var) nil))
313 | (setq url-http-method url-request-method
314 | url-http-extra-headers url-request-extra-headers
315 | url-http-noninteractive url-request-noninteractive
316 | url-http-data url-request-data
317 | ;; `url-http' will close the connection if:
318 | ;;
319 | ;; - There is not a "Connection: keep-alive" header (HTTP/1.0)
320 | ;; - There is a "Connection: close" header (HTTP/1.1 and greater)
321 | ;;
322 | ;; That means `url-http-process' cannot be `nil'. We have to
323 | ;; assign it to a process object.
324 | url-http-process proc
325 | url-http-chunked-length nil
326 | url-http-chunked-start nil
327 | url-http-chunked-counter 0
328 | url-callback-function callback
329 | url-callback-arguments cbargs
330 | url-http-after-change-function 'url-http-wait-for-headers-change-function
331 | url-http-target-url url-current-object
332 | url-http-no-retry retry-buffer
333 | url-http-connection-opened nil
334 | url-mime-accept-string mime-accept-string
335 | url-http-proxy url-using-proxy
336 | url-http-referer referer))
337 | buf))
338 |
339 | ;;;###autoload
340 | (defun mb-url-http-around-advice
341 | (fn url callback cbargs &optional retry-buffer &rest rest-args)
342 | "Around advice for `url-http'.
343 |
344 | FN is the original function.
345 |
346 | URL must be a parsed URL. See `url-generic-parse-url' for details.
347 |
348 | When retrieval is completed, the multibyte flag of the retrieval buffer is set
349 | to nil, then execute the function CALLBACK.
350 |
351 | CBARGS, RETRY-BUFFER and REST-ARGS are arguments for FN."
352 | ;; `rest-args' is required because `url-http' adds an argument called
353 | ;; `gateway-method' since Emacs 25.
354 | (apply (if mb-url-http-backend #'mb-url-http fn)
355 | url
356 | (lambda (&rest args)
357 | (set-buffer-multibyte nil)
358 | (apply callback args))
359 | cbargs retry-buffer rest-args))
360 |
361 | (defun mb-url-http--stderr-buffer-name (url)
362 | "Generate process stderr buffer name based on URL."
363 | (format "*mb-url-http-%s-%s-ERROR*" url-request-method (url-recreate-url url)))
364 |
365 | (defun mb-url-http-make-pipe-process (url name buffer command &optional sentinel)
366 | "Make a pipe process.
367 |
368 | URL is used to create the process stderr buffer if needed.
369 |
370 | Pass NAME, BUFFER, COMMAND and SENTINEL to `make-process' as is.
371 |
372 | If SENTINEL is nil, `mb-url-http-sentinel' will be used."
373 | (let* ((stderr (cond ((null mb-url-http-stderr)
374 | (messages-buffer))
375 | ((eq mb-url-http-stderr t)
376 | (mb-url-http--stderr-buffer-name url))
377 | ((or (symbolp mb-url-http-stderr)
378 | (functionp mb-url-http-stderr))
379 | (funcall mb-url-http-stderr url))
380 | (t
381 | mb-url-http-stderr)))
382 | (proc (make-process :name name
383 | :buffer buffer
384 | :command command
385 | :connection-type 'pipe
386 | :stderr stderr
387 | :sentinel (or sentinel #'mb-url-http-sentinel))))
388 | (mb-url-http-process-send-url-request-data proc)
389 | proc))
390 |
391 |
392 | (defcustom mb-url-http-curl-program "curl"
393 | "Curl program."
394 | :type 'string
395 | :group 'mb-url)
396 |
397 | (defcustom mb-url-http-curl-switches '()
398 | "List of strings specifying switches to be passed to Curl."
399 | :type '(repeat (string))
400 | :group 'mb-url)
401 |
402 | (defun mb-url-http--curl-command-list (url)
403 | "Return curl command list for URL."
404 | `(,mb-url-http-curl-program
405 | "--silent" "--show-error" "--include" "--compressed"
406 | ,@(if (string= "HEAD" url-request-method)
407 | (list "--head")
408 | (list "--request" url-request-method))
409 | "--data-binary" "@-"
410 | ,@(apply #'append
411 | (mapcar (lambda (arg) (list "--header" arg))
412 | (mapcar #'mb-url-http-header-field-to-argument
413 | (mb-url-http-extra-headers url))))
414 | ,(url-recreate-url url)
415 | ,@mb-url-http-curl-switches))
416 |
417 | (defun mb-url-http-sentinel--curl (proc evt)
418 | "Sentinel for Curl.
419 |
420 | Curl return the proxy response before the actual remote server response.
421 | It makes Emacs hard to parse the response message. Delete the proxy response
422 | first.
423 |
424 | PROC is the process.
425 |
426 | EVT describes the type of event."
427 | (when (string= evt "finished\n")
428 | (with-current-buffer (process-buffer proc)
429 | (mb-url-http--delete-proxy-response)))
430 | (mb-url-http-sentinel proc evt))
431 |
432 | ;;;###autoload
433 | (defun mb-url-http-curl (name url buffer default-sentinel)
434 | "\"cURL\" backend for `mb-url-http'.
435 |
436 | NAME is the process name.
437 |
438 | URL is the url which curl sends the request data to.
439 |
440 | BUFFER is the process buffer.
441 |
442 | DEFAULT-SENTINEL is the default sentinel of mb-url. But curl backend uses its
443 | own sentinel instead."
444 | (mb-url-http-make-pipe-process
445 | url name buffer
446 | (mb-url-http--curl-command-list url)
447 | #'mb-url-http-sentinel--curl))
448 |
449 |
450 | (defcustom mb-url-http-httpie-program "http"
451 | "HTTPie program."
452 | :type 'string
453 | :group 'mb-url)
454 |
455 | (defcustom mb-url-http-httpie-switches '()
456 | "List of strings specifying switches to be passed to HTTPie."
457 | :type '(repeat (string))
458 | :group 'mb-url)
459 |
460 | (defun mb-url-http--httpie-extra-headers (url)
461 | "Get extra HTTP headers for URL.
462 |
463 | Remove internal headers for HTTPie from the headers."
464 | (seq-remove (lambda (pair)
465 | (member (car-safe pair)
466 | ;; https://httpie.io/docs/cli/redirected-input
467 | '("Content-Length")))
468 | (mb-url-http-extra-headers url)))
469 |
470 | (defun mb-url-http--httpie-command-list (url)
471 | "Return httpie command list for URL."
472 | `(,mb-url-http-httpie-program
473 | "--print" "hb" "--pretty" "none"
474 | ,url-request-method ,(url-recreate-url url)
475 | ,@(mapcar #'mb-url-http-header-field-to-argument
476 | (mb-url-http--httpie-extra-headers url))
477 | ,@mb-url-http-httpie-switches))
478 |
479 | ;;;###autoload
480 | (defun mb-url-http-httpie (name url buffer default-sentinel)
481 | "HTTPie backend for `mb-url-http'.
482 |
483 | NAME is the process name.
484 |
485 | URL is the url which httpie sends the request data to.
486 |
487 | BUFFER is the process buffer.
488 |
489 | DEFAULT-SENTINEL is the default sentinel of mb-url."
490 | (mb-url-http-make-pipe-process
491 | url name buffer
492 | (mb-url-http--httpie-command-list url)
493 | default-sentinel))
494 |
495 | (provide 'mb-url-http)
496 |
497 | ;;; mb-url-http.el ends here
498 |
--------------------------------------------------------------------------------
/mb-url.el:
--------------------------------------------------------------------------------
1 | ;;; mb-url.el --- Multiple Backends for Emacs URL package -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2015, 2016, 2018, 2019, 2021-2023 ZHANG Weiyi
4 |
5 | ;; Author: ZHANG Weiyi
6 | ;; Version: 0.12.0
7 | ;; Package-Requires: ((emacs "25"))
8 | ;; Keywords: comm, data, processes, hypermedia
9 | ;; URL: https://github.com/dochang/mb-url
10 |
11 | ;; This file is not part of GNU Emacs.
12 |
13 | ;;; License:
14 |
15 | ;; This program is free software: you can redistribute it and/or modify it
16 | ;; under the terms of the GNU General Public License as published by the Free
17 | ;; Software Foundation, either version 3 of the License, or (at your option)
18 | ;; any later version.
19 |
20 | ;; This program is distributed in the hope that it will be useful, but WITHOUT
21 | ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22 | ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
23 | ;; more details.
24 |
25 | ;; You should have received a copy of the GNU General Public License along with
26 | ;; this program. If not, see .
27 |
28 | ;;; Commentary:
29 |
30 | ;;
31 | ;; [](http://melpa.org/#/mb-url)
32 | ;; [](http://stable.melpa.org/#/mb-url)
33 | ;; [](https://github.com/dochang/mb-url/actions/workflows/ci.yml)
34 | ;; [](https://dl.circleci.com/status-badge/redirect/gh/dochang/mb-url/tree/master)
35 | ;; [](http://isitmaintained.com/project/dochang/mb-url "Average time to resolve an issue")
36 | ;; [](http://isitmaintained.com/project/dochang/mb-url "Percentage of issues still open")
37 | ;; [](https://github.com/dochang/mb-url)
38 | ;; [](https://github.com/dochang/mb-url)
39 | ;; [](https://github.com/dochang/mb-url/blob/master/LICENSE)
40 | ;; [](https://saythanks.io/to/dochang)
41 | ;;
47 | ;;
48 | ;;
49 | ;; Multiple Backends for URL package.
50 | ;;
51 | ;; This package provides several backends for `url-retrieve' &
52 | ;; `url-retrieve-synchronously', which replace the internal implementation.
53 | ;;
54 | ;; The motivation of this package is I can't connect HTTPS url behind proxy
55 | ;; (Related bugs: [#11788][], [#12636][], [#18860][], [msg00756][], [#10][]).
56 | ;;
57 | ;; [#11788]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11788
58 | ;; [#12636]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=12636
59 | ;; [#18860]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18860
60 | ;; [msg00756]: https://lists.gnu.org/archive/html/help-gnu-emacs/2015-08/msg00756.html
61 | ;; [#10]: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=10
62 |
63 | ;; Notice:
64 | ;;
65 | ;; As the URL package has supported HTTPS over proxies supporting CONNECT since
66 | ;; Emacs 26, this package is no longer recommended. But it can still be used
67 | ;; in Emacs 26+.
68 |
69 | ;; Installation:
70 | ;;
71 | ;; `mb-url' is available on [MELPA] and [el-get].
72 | ;;
73 | ;; [MELPA]: https://melpa.org/
74 | ;; [el-get]: https://github.com/dimitri/el-get
75 | ;;
76 | ;; To install `mb-url' from git repository, clone the repo, then add the repo
77 | ;; dir into `load-path'.
78 | ;;
79 | ;; `mb-url' depends on `cl-lib'; The test code also depends on `s'.
80 |
81 | ;; Backends:
82 | ;;
83 | ;; Currently only support `url-http'.
84 | ;;
85 | ;; `url-http`:
86 | ;;
87 | ;; Install `mb-url-http-around-advice' to use `mb-url-http' backends.
88 | ;;
89 | ;; ```elisp
90 | ;; (advice-add 'url-http :around 'mb-url-http-around-advice)
91 | ;; ```
92 | ;;
93 | ;; All backend functions receive `(name url buffer default-sentinel)', return a
94 | ;; process.
95 | ;;
96 | ;; `mb-url-http-backend' indicates the current backend. If the backend is
97 | ;; `nil', which means no backend, `url-http' will be called.
98 | ;;
99 | ;; E.g.,
100 | ;;
101 | ;; ```elisp
102 | ;; (setq mb-url-http-backend 'mb-url-http-curl)
103 | ;; ```
104 | ;;
105 | ;; NOTE: All clients are required to support automatically decompressing
106 | ;; response bodies.
107 | ;;
108 | ;; #### [cURL][]
109 | ;;
110 | ;; [cURL]: http://curl.haxx.se/
111 | ;;
112 | ;; ##### `mb-url-http-curl'
113 | ;;
114 | ;; cURL backend for `url-http'.
115 | ;;
116 | ;; ##### `mb-url-http-curl-program'
117 | ;;
118 | ;; cURL program.
119 | ;;
120 | ;; ##### `mb-url-http-curl-switches'
121 | ;;
122 | ;; cURL switches.
123 | ;;
124 | ;; #### [HTTPie][]
125 | ;;
126 | ;; [HTTPie]: http://httpie.org/
127 | ;;
128 | ;; ##### `mb-url-http-httpie'
129 | ;;
130 | ;; HTTPie backend for `url-http'.
131 | ;;
132 | ;; ##### `mb-url-http-httpie-program'
133 | ;;
134 | ;; HTTPie program.
135 | ;;
136 | ;; ##### `mb-url-http-httpie-switches'
137 | ;;
138 | ;; HTTPie switches.
139 | ;;
140 | ;; ##### `mb-url-http-httpie-supported-content-encoding-list'
141 | ;;
142 | ;; Content encodings which HTTPie supports to decode.
143 | ;;
144 | ;; If your HTTPie supports to decode a encoding like `br`, put the encoding
145 | ;; into this list.
146 | ;;
147 | ;; By default, HTTPie supports to decode `gzip` and `deflate`.
148 | ;;
149 | ;; ##### `mb-url-http-httpie-content-encoding-fix-function'
150 | ;;
151 | ;; A function to fix the value of `Content-Encoding` for HTTPie. Default
152 | ;; value is `mb-url-http-httpie-delete-content-encoding-from-list'.
153 |
154 | ;; License:
155 | ;;
156 | ;; GPLv3
157 |
158 | ;; Acknowledgements:
159 | ;;
160 | ;;
161 |
162 | ;;; Code:
163 |
164 | (require 'cl-lib)
165 |
166 | (defgroup mb-url ()
167 | "Multiple Backends for URL package."
168 | :prefix "mb-url-"
169 | :group 'url)
170 |
171 | (defmacro mb-url-with-gensyms (symbols &rest body)
172 | "Bind SYMBOLS to unique temporary symbols then execute BODY in the context."
173 | (declare (indent 1))
174 | `(let ,(mapcar (lambda (sym) `(,sym (cl-gensym))) symbols)
175 | ,@body))
176 |
177 | (defun mb-url-string-empty-p (string)
178 | "Check whether STRING is nil or empty."
179 | (or (null string)
180 | (string= string "")))
181 |
182 | (provide 'mb-url)
183 |
184 | ;;; mb-url.el ends here
185 |
--------------------------------------------------------------------------------
/renovate.json5:
--------------------------------------------------------------------------------
1 | {
2 | $schema: "https://docs.renovatebot.com/renovate-schema.json",
3 | extends: ["config:base"],
4 | packageRules: [
5 | {
6 | matchPackagePatterns: ["*"],
7 | matchUpdateTypes: ["minor", "patch"],
8 | groupName: "all non-major dependencies",
9 | groupSlug: "all-minor-patch",
10 | },
11 | ],
12 | // Combine all minor and patch updates to one branch/PR.
13 | // https://stackoverflow.com/a/67071518
14 | // https://docs.renovatebot.com/presets-group/#groupallnonmajor
15 | }
16 |
--------------------------------------------------------------------------------
/test/mb-url-test.el:
--------------------------------------------------------------------------------
1 | ;;; mb-url-test.el --- Tests for mb-url -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2015, 2016, 2018, 2019 ZHANG Weiyi
4 |
5 | ;; Author: ZHANG Weiyi
6 |
7 | ;; This file is not part of GNU Emacs.
8 |
9 | ;;; License:
10 |
11 | ;; This program is free software: you can redistribute it and/or modify it
12 | ;; under the terms of the GNU General Public License as published by the Free
13 | ;; Software Foundation, either version 3 of the License, or (at your option)
14 | ;; any later version.
15 |
16 | ;; This program is distributed in the hope that it will be useful, but WITHOUT
17 | ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 | ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
19 | ;; more details.
20 |
21 | ;; You should have received a copy of the GNU General Public License along with
22 | ;; this program. If not, see .
23 |
24 | ;;; Commentary:
25 |
26 | ;; Tests for mb-url
27 |
28 | ;;; Code:
29 |
30 | (require 'ert)
31 | (require 'cl-lib)
32 | (require 'json)
33 | (require 'url)
34 | (require 'url-http)
35 |
36 | (require 's)
37 |
38 | (require 'mb-url)
39 | (require 'mb-url-http)
40 |
41 | ;; Do not truncate the backtrace. This makes ERT easy to debug.
42 | (setq ert-batch-backtrace-right-margin 256)
43 |
44 | (setq mb-url-test--mockapi-prefix
45 | (let ((prefix (getenv "MB_URL_TEST__MOCKAPI_PREFIX")))
46 | (if (mb-url-string-empty-p prefix)
47 | "https://httpbingo.org"
48 | prefix)))
49 |
50 | (cl-defstruct (mb-url-test-response
51 | (:constructor mb-url-test-make-response)
52 | (:copier mb-url-test-copy-response))
53 | raw-string version status-code headers body json)
54 |
55 | (defun mb-url-test-response-header (field-name response)
56 | (cdr-safe (assoc-string field-name (mb-url-test-response-headers response) t)))
57 |
58 | (defun mb-url-test-parse-response (&optional buffer skip-json)
59 | (unless buffer
60 | (setq buffer (current-buffer)))
61 | (let ((resp (mb-url-test-make-response)))
62 | (with-current-buffer buffer
63 | (save-excursion
64 | (goto-char (point-min))
65 | (setf (mb-url-test-response-raw-string resp) (buffer-string))
66 | (re-search-forward "^HTTP/")
67 | (setf (mb-url-test-response-version resp)
68 | (buffer-substring (point)
69 | (progn (skip-chars-forward "0-9.") (point))))
70 | (setf (mb-url-test-response-status-code resp) (read (current-buffer)))
71 | (re-search-forward "\n")
72 | (while (not (looking-at-p "^\n"))
73 | (re-search-forward "^\\([^:]*\\):\\(.*\\)\n")
74 | (let ((key (match-string 1))
75 | (val (s-trim (match-string 2))))
76 | (setf (mb-url-test-response-headers resp)
77 | (cons (cons key val) (mb-url-test-response-headers resp)))))
78 | (re-search-forward "^\n")
79 | (setf (mb-url-test-response-body resp)
80 | (buffer-substring (point) (point-max)))
81 | (when (and (not skip-json)
82 | (equal "application/json"
83 | (car (mail-header-parse-content-type
84 | (mb-url-test-response-header "Content-Type" resp)))))
85 | (setf (mb-url-test-response-json resp)
86 | (json-read-from-string (mb-url-test-response-body resp))))))
87 | resp))
88 |
89 | ;; Sometimes HTTP clients may be dead for unknown reason. We have to wrap
90 | ;; `url-retrieve-synchronously'.
91 | (defun mb-url-test--fetch (url &optional silent inhibit-cookies timeout)
92 | (let (buffer)
93 | (while (null buffer)
94 | (setq buffer (url-retrieve-synchronously url silent inhibit-cookies timeout)))
95 | buffer))
96 |
97 | (ert-deftest mb-url-test-100-parse-response ()
98 | (let* ((headers "HTTP/1.1 200 OK
99 | Server: nginx
100 | Date: Wed, 02 Dec 2015 16:23:47 GMT
101 | Content-Type: application/json
102 | Content-Length: 230
103 | Connection: keep-alive
104 | Access-Control-Allow-Origin: *
105 | Access-Control-Allow-Credentials: true
106 |
107 | ")
108 | (body "{
109 | \"args\": {},
110 | \"headers\": {
111 | \"Accept\": \"*/*\",
112 | \"Accept-Encoding\": \"gzip, deflate\",
113 | \"Host\": \"httpbin.org\"
114 | },
115 | \"url\": \"https://httpbin.org/get\"
116 | }
117 | ")
118 | (raw-string (concat headers body)))
119 | (with-temp-buffer
120 | (insert raw-string)
121 | (goto-char (point-min))
122 | (let ((resp (mb-url-test-parse-response)))
123 | (should (string= (mb-url-test-response-raw-string resp) raw-string))
124 | (should (string= (mb-url-test-response-version resp) "1.1"))
125 | (should (= (mb-url-test-response-status-code resp) 200))
126 | (should (equal (mb-url-test-response-header "Content-Length" resp)
127 | "230"))
128 | (should (string= (mb-url-test-response-body resp) body))
129 | (should (equal (assoc-default 'url (mb-url-test-response-json resp))
130 | "https://httpbin.org/get"))))))
131 |
132 | (ert-deftest mb-url-test-101-header-field-to-argument ()
133 | (mapc (lambda (case)
134 | (let ((field (car case))
135 | (expected (cdr case)))
136 | (string= (mb-url-http-header-field-to-argument field) expected)))
137 | '((("X-Foo1" . "bar") . "X-Foo1:bar")
138 | (("X-Foo2" . "") . "X-Foo2;")
139 | (("X-Foo3" . nil) . "X-Foo3"))))
140 |
141 | (ert-deftest mb-url-test-300-http--goto-next-body ()
142 | (mapc (lambda (case)
143 | (let ((text (nth 0 case))
144 | (char (nth 1 case))
145 | (errtype (nth 2 case)))
146 | (with-temp-buffer
147 | (insert text)
148 | (goto-char (point-min))
149 | (cond (errtype
150 | (should-error (mb-url-http--goto-next-body) :type errtype))
151 | (t
152 | (mb-url-http--goto-next-body)
153 | (should (= (following-char) char)))))))
154 | '(("a\r\nb\r\n\r\nc" ?c nil)
155 | ("a\nb\n\nc" ?c nil)
156 | ("a\rb\r\rc" ?c search-failed))))
157 |
158 | (ert-deftest mb-url-test-301-http--delete-proxy-response ()
159 | (mapc (lambda (case)
160 | (let ((before (nth 0 case))
161 | (after (nth 1 case)))
162 | (with-temp-buffer
163 | (insert before)
164 | (goto-char (point-min))
165 | (mb-url-http--delete-proxy-response)
166 | (should (string= (buffer-string) after)))))
167 | '(("HTTP/1.1 200 Connection established\r\nProxy-Header: foo\r\n\r\nHTTP/1.1 200 OK\r\nHeader: bar\r\n\r\nbody...\r\n"
168 | "HTTP/1.1 200 OK\r\nHeader: bar\r\n\r\nbody...\r\n")
169 | ("HTTP/1.1 200 Connection established\nProxy-Header: foo\n\nHTTP/1.1 200 OK\nHeader: bar\n\nbody...\n"
170 | "HTTP/1.1 200 OK\nHeader: bar\n\nbody...\n")
171 | ("HTTP/1.1 200 Connection established\rProxy-Header: foo\r\rHTTP/1.1 200 OK\rHeader: bar\r\rbody...\r"
172 | "HTTP/1.1 200 Connection established\rProxy-Header: foo\r\rHTTP/1.1 200 OK\rHeader: bar\r\rbody...\r"))))
173 |
174 | (ert-deftest mb-url-test-302-http--delete-carriage-return ()
175 | (mapc (lambda (case)
176 | (let ((before (nth 0 case))
177 | (after (nth 1 case)))
178 | (with-temp-buffer
179 | (insert before)
180 | (goto-char (point-min))
181 | (make-local-variable 'url-http-end-of-headers)
182 | (mb-url-http--delete-carriage-return)
183 | (should (string= (buffer-string) after)))))
184 | '(("HTTP/1.1 200 OK\r\nHeader: bar\r\n\r\nbody...\r\n"
185 | "HTTP/1.1 200 OK\nHeader: bar\n\nbody...\r\n")
186 | ("HTTP/1.1 200 OK\nHeader: bar\n\nbody...\n"
187 | "HTTP/1.1 200 OK\nHeader: bar\n\nbody...\n")
188 | ("HTTP/1.1 200 OK\nHeader: bar\n\nline1...\r\nline2...\r\n"
189 | "HTTP/1.1 200 OK\nHeader: bar\n\nline1...\r\nline2...\r\n"))))
190 |
191 | (ert-deftest mb-url-test-303-http--fix-header ()
192 | (let ((before "HTTP/1.1 200 OK\nFoo: 1\nBar: 2\nFoo: 3\nBaz: 4\n\nbody...\n"))
193 | (mapc (lambda (fix)
194 | (let ((header (nth 0 fix))
195 | (fn (nth 1 fix))
196 | (after (nth 2 fix)))
197 | (with-temp-buffer
198 | (insert before)
199 | (goto-char (point-min))
200 | (mb-url-http--fix-header header fn nil nil t)
201 | (should (string= (buffer-string) after)))))
202 | (list
203 | (list "Foo"
204 | (lambda (args) nil)
205 | "HTTP/1.1 200 OK\nBar: 2\nBaz: 4\n\nbody...\n")
206 | (list "Foo"
207 | (lambda (args) "0")
208 | "HTTP/1.1 200 OK\nBar: 2\nBaz: 4\nFoo: 0\n\nbody...\n")
209 | (list "Foo"
210 | (lambda (args) t)
211 | "HTTP/1.1 200 OK\nFoo: 1\nBar: 2\nFoo: 3\nBaz: 4\n\nbody...\n")))))
212 |
213 | (ert-deftest mb-url-test-304-http--delete-content-encoding ()
214 | (mapc (lambda (case)
215 | (let ((before (car case))
216 | (after (cadr case)))
217 | (with-temp-buffer
218 | (insert before)
219 | (goto-char (point-min))
220 | (mb-url-http--delete-content-encoding)
221 | (should (string= (buffer-string) after)))))
222 | '(("HTTP/1.1 200 OK\nContent-Encoding: gzip\nFoo: 1\n\nbody...\n"
223 | "HTTP/1.1 200 OK\nFoo: 1\n\nbody...\n")
224 | ("HTTP/1.1 200 OK\nFoo: 1\nContent-Encoding: gzip\n\nbody...\n"
225 | "HTTP/1.1 200 OK\nFoo: 1\n\nbody...\n")
226 | ("HTTP/1.1 200 OK\nFoo: 1\nContent-Encoding: gzip\nBar: 2\n\nbody...\n"
227 | "HTTP/1.1 200 OK\nFoo: 1\nBar: 2\n\nbody...\n")
228 | ("HTTP/1.1 200 OK\nFoo: 1\nBar: 2\n\nbody...\n"
229 | "HTTP/1.1 200 OK\nFoo: 1\nBar: 2\n\nbody...\n"))))
230 |
231 | (ert-deftest mb-url-test-305-http--reset-end-of-headers ()
232 | (mapc (lambda (case)
233 | (let ((expected (nth 0 case))
234 | (msg (nth 1 case)))
235 | (with-temp-buffer
236 | (insert msg)
237 | (goto-char (point-min))
238 | (make-local-variable 'url-http-end-of-headers)
239 | (mb-url-http--reset-end-of-headers)
240 | (should (= expected (marker-position url-http-end-of-headers))))))
241 | '((31 ;; Buffer starts from 1.
242 | "HTTP/1.1 200 OK\nFoo: 1\nBar: 2\n\nbody...\n")
243 | (35 ;; Buffer starts from 1.
244 | "HTTP/1.1 200 OK\r\nFoo: 1\r\nBar: 2\r\n\r\nbody...\n"))))
245 |
246 | (ert-deftest mb-url-test-400-http--url-http-variables ()
247 | (mapc (lambda (case)
248 | (cl-destructuring-bind
249 | (mime-accept-string request-noninteractive current-lastloc url-string)
250 | case
251 | (let* ((mb-url-http-backend (lambda (&rest args) nil))
252 | (url-privacy-level 'none)
253 | (url-lastloc-privacy-level 'none)
254 | (url-mime-accept-string mime-accept-string)
255 | (url-request-noninteractive request-noninteractive)
256 | (url-current-lastloc current-lastloc)
257 | (url (url-generic-parse-url url-string))
258 | (buf (mb-url-http url nil nil nil nil)))
259 | (with-current-buffer buf
260 | (should (string= url-mime-accept-string mime-accept-string))
261 | (should (string= url-request-noninteractive request-noninteractive))
262 | (should (string= url-http-referer (if (fboundp 'url-http--get-referer)
263 | current-lastloc
264 | nil))))
265 | (kill-buffer buf))))
266 | '(("*/*" t "http://foo/a" "http://foo/b"))))
267 |
268 | (ert-deftest mb-url-test-401-http--extra-variables ()
269 | (mapc (lambda (case)
270 | (let* ((url-request-extra-headers case)
271 | (url-personal-mail-address "From*")
272 | (url-mime-encoding-string "Accept-Encoding*")
273 | (url-mime-charset-string "Accept-Charset*")
274 | (url-mime-language-string "Accept-Language*")
275 | (url-mime-accept-string "Accept*")
276 | (url-request-data "lorem ipsum")
277 | (headers (mb-url-http-extra-headers
278 | (url-generic-parse-url "http://foo/a")))
279 | (fn (lambda (v header)
280 | (let ((hv1 (cdr-safe (assoc-string header url-request-extra-headers t)))
281 | (hv2 (cdr-safe (assoc-string header headers t))))
282 | (cond ((and v (null hv1))
283 | (should (equal v hv2)))
284 | (t
285 | (should (equal hv1 hv2))))))))
286 | (funcall fn url-personal-mail-address "From")
287 | (funcall fn url-mime-encoding-string "Accept-Encoding")
288 | (funcall fn url-mime-charset-string "Accept-Charset")
289 | (funcall fn url-mime-language-string "Accept-Language")
290 | (funcall fn url-mime-accept-string "Accept")
291 | (funcall fn (number-to-string (length url-request-data)) "Content-Length")))
292 | '(()
293 | (("From" . "bar@foo.com")
294 | ("Accept-Encoding" . "br;q=1.0, gzip;q=0.8, *;q=0.1")
295 | ("Accept-Charset" . "utf-8, iso-8859-1;q=0.5, *;q=0.1")
296 | ("Accept-Language" . "zh-CN,zh;q=0.8, en-US;q=0.3, en;q=0.2, *;q=0.1")
297 | ("Accept" . "text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8")
298 | ("Content-Length" . "42")))))
299 |
300 | (ert-deftest mb-url-test-500-http ()
301 | (unwind-protect
302 | (progn
303 | (advice-add 'url-http :around 'mb-url-http-around-advice)
304 | (mapc (lambda (backend)
305 | (let ((mb-url-http-backend backend))
306 | ;; GET
307 | (let* ((url (format "%s/get?foo=bar" mb-url-test--mockapi-prefix)))
308 | (with-current-buffer (mb-url-test--fetch url t t)
309 | (goto-char (point-min))
310 | (let* ((resp (mb-url-test-parse-response))
311 | (json (mb-url-test-response-json resp)))
312 | (should (= (mb-url-test-response-status-code resp) 200))
313 | (should (equal
314 | (car (mail-header-parse-content-type
315 | (mb-url-test-response-header "Content-Type" resp)))
316 | "application/json"))
317 | (should (equal
318 | (aref (assoc-default 'foo (assoc-default 'args json)) 0)
319 | "bar")))))
320 | ;; POST with request data
321 | (let* ((url (format "%s/post" mb-url-test--mockapi-prefix))
322 | (url-request-method "POST")
323 | (url-request-extra-headers '(("Content-Type" . "text/plain")))
324 | (url-request-data "foobar"))
325 | (with-current-buffer (mb-url-test--fetch url t t)
326 | (goto-char (point-min))
327 | (let* ((resp (mb-url-test-parse-response))
328 | (json (mb-url-test-response-json resp)))
329 | (should (= (mb-url-test-response-status-code resp) 200))
330 | (should (equal
331 | (car (mail-header-parse-content-type
332 | (mb-url-test-response-header "Content-Type" resp)))
333 | "application/json"))
334 | (should (equal
335 | (car (mail-header-parse-content-type
336 | (aref (assoc-default 'Content-Type (assoc-default 'headers json)) 0)))
337 | "text/plain"))
338 | (should (equal (assoc-default 'data json) url-request-data)))))))
339 | (list 'mb-url-http-curl
340 | #'mb-url-http-curl
341 | 'mb-url-http-httpie
342 | #'mb-url-http-httpie))
343 | (mapc (lambda (backend)
344 | (let ((mb-url-http-backend backend)
345 | (url (format "%s/get?foo=bar" mb-url-test--mockapi-prefix)))
346 | (should-error (mb-url-test--fetch url t t))))
347 | (list 'mb-url-test--foobar
348 | #'mb-url-test--foobar)))
349 | (advice-remove 'url-http 'mb-url-http-around-advice)))
350 |
351 | (ert-deftest mb-url-test-501-sentinal ()
352 | (unwind-protect
353 | (progn
354 | (advice-add 'url-http :around 'mb-url-http-around-advice)
355 | (mapc (lambda (backend)
356 | (let* ((mb-url-http-backend backend)
357 | (url (format "%s/image/png" mb-url-test--mockapi-prefix)))
358 | (with-current-buffer (mb-url-test--fetch url t t)
359 | (goto-char (point-min))
360 | (let ((end-of-headers
361 | (save-excursion
362 | (goto-char (point-min))
363 | (re-search-forward "\n\n" nil t))))
364 | (should
365 | (string=
366 | (buffer-substring end-of-headers (+ end-of-headers 8))
367 | (unibyte-string #x89 #x50 #x4e #x47 #x0d #x0a #x1a #x0a)))))))
368 | (list 'mb-url-http-curl
369 | #'mb-url-http-curl
370 | 'mb-url-http-httpie
371 | #'mb-url-http-httpie)))
372 | (advice-remove 'url-http 'mb-url-http-around-advice)))
373 |
374 | (ert-deftest mb-url-test-502-unibyte ()
375 | (unwind-protect
376 | (progn
377 | (advice-add 'url-http :around 'mb-url-http-around-advice)
378 | (mapc (lambda (backend)
379 | (let* ((mb-url-http-backend backend)
380 | (url (format "%s/post" mb-url-test--mockapi-prefix))
381 | (url-request-method "POST")
382 | (url-request-extra-headers '(("Content-Type" . "text/plain; charset=utf-8")))
383 | (url-request-data "你好,世界"))
384 | (with-current-buffer (mb-url-test--fetch url t t)
385 | (goto-char (point-min))
386 | (let* ((resp (mb-url-test-parse-response))
387 | (json (mb-url-test-response-json resp)))
388 | (should (= (mb-url-test-response-status-code resp) 200))
389 | (should (equal
390 | (car (mail-header-parse-content-type
391 | (mb-url-test-response-header "Content-Type" resp)))
392 | "application/json"))
393 | (should (equal
394 | (car (mail-header-parse-content-type
395 | (aref (assoc-default 'Content-Type (assoc-default 'headers json)) 0)))
396 | "text/plain"))
397 | (should (equal
398 | (decode-coding-string (assoc-default 'data json) 'utf-8)
399 | url-request-data))))))
400 | (list 'mb-url-http-curl
401 | #'mb-url-http-curl
402 | 'mb-url-http-httpie
403 | #'mb-url-http-httpie)))
404 | (advice-remove 'url-http 'mb-url-http-around-advice)))
405 |
406 | (ert-deftest mb-url-test-503-sentinel-zlib-unibyte ()
407 | (unwind-protect
408 | (progn
409 | (advice-add 'url-http :around 'mb-url-http-around-advice)
410 | (mapc (lambda (backend)
411 | (let* ((mb-url-http-backend backend)
412 | (url (format "%s/gzip" mb-url-test--mockapi-prefix))
413 | (url-request-method "GET"))
414 | (with-current-buffer (mb-url-test--fetch url t t)
415 | (let* ((resp (mb-url-test-parse-response))
416 | (json (mb-url-test-response-json resp)))
417 | (should (= (mb-url-test-response-status-code resp) 200))
418 | (should (null (mb-url-test-response-header "Content-Encoding" resp)))
419 | (should (assoc-default 'gzipped json))))))
420 | (list
421 | 'mb-url-http-curl
422 | #'mb-url-http-curl
423 | 'mb-url-http-httpie
424 | #'mb-url-http-httpie)))
425 | (advice-remove 'url-http 'mb-url-http-around-advice)))
426 |
427 | (provide 'mb-url-test)
428 |
429 | ;;; mb-url-test.el ends here
430 |
--------------------------------------------------------------------------------