Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9203df94a0
|
||
|
|
a7204f588f | ||
|
|
81367e5f3a
|
||
|
|
14cb3485e4
|
||
|
|
58d3b70bee
|
||
|
|
ea4a30ca00
|
||
|
|
9e9ec9ba9b
|
||
|
|
a98c41f461
|
||
|
|
9064d5bd34
|
||
|
|
de00c532c8
|
||
|
|
8892337b93
|
||
|
|
15b9f979a2 |
@@ -3,6 +3,72 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
|
## 2022-06-24
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Packages with breaking changes:
|
||||||
|
|
||||||
|
- There are no breaking changes in this release.
|
||||||
|
|
||||||
|
Packages with other changes:
|
||||||
|
|
||||||
|
- [`wyatt_http_client` - `v1.2.0`](#wyatt_http_client---v120)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### `wyatt_http_client` - `v1.2.0`
|
||||||
|
|
||||||
|
- **FEAT**: add new middleware feature.
|
||||||
|
- **FEAT**: implements doublelinked list for middlewares.
|
||||||
|
- **FEAT**: [WIP] implements middleware system.
|
||||||
|
- **FEAT**: [WIP] work on middleware feature.
|
||||||
|
|
||||||
|
|
||||||
|
## 2022-05-23
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Packages with breaking changes:
|
||||||
|
|
||||||
|
- There are no breaking changes in this release.
|
||||||
|
|
||||||
|
Packages with other changes:
|
||||||
|
|
||||||
|
- [`wyatt_http_client` - `v1.1.0`](#wyatt_http_client---v110)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### `wyatt_http_client` - `v1.1.0`
|
||||||
|
|
||||||
|
- **FEAT**: add oauth2 refresh token client.
|
||||||
|
|
||||||
|
|
||||||
|
## 2022-05-23
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Packages with breaking changes:
|
||||||
|
|
||||||
|
- There are no breaking changes in this release.
|
||||||
|
|
||||||
|
Packages with other changes:
|
||||||
|
|
||||||
|
- [`wyatt_analysis` - `v2.1.0`](#wyatt_analysis---v210)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### `wyatt_analysis` - `v2.1.0`
|
||||||
|
|
||||||
|
- **FEAT**: add experimental rules in appropriate file.
|
||||||
|
|
||||||
|
|
||||||
## 2022-05-20
|
## 2022-05-20
|
||||||
|
|
||||||
### Changes
|
### Changes
|
||||||
|
|||||||
@@ -1,3 +1,7 @@
|
|||||||
|
## 2.1.0
|
||||||
|
|
||||||
|
- **FEAT**: add experimental rules in appropriate file.
|
||||||
|
|
||||||
## 2.0.1
|
## 2.0.1
|
||||||
|
|
||||||
- **DOCS**: Update readme with new version.
|
- **DOCS**: Update readme with new version.
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
name: wyatt_analysis
|
name: wyatt_analysis
|
||||||
description: Lint rules for Dart and Flutter used internally at Wyatt and Wyatt Studio.
|
description: Lint rules for Dart and Flutter used internally at Wyatt and Wyatt Studio.
|
||||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis
|
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis
|
||||||
version: 2.0.1
|
version: 2.1.0
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: '>=2.12.0 <3.0.0'
|
sdk: '>=2.12.0 <3.0.0'
|
||||||
@@ -35,5 +35,5 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
|
|||||||
@@ -1,14 +1,3 @@
|
|||||||
/*
|
|
||||||
* Author: Hugo Pointcheval
|
|
||||||
* Email: git@pcl.ovh
|
|
||||||
* -----
|
|
||||||
* File: LICENSE
|
|
||||||
* Created Date: 20/05/2022 16:47:39
|
|
||||||
* Last Modified: 20/05/2022 16:47:39
|
|
||||||
* -----
|
|
||||||
* Copyright (c) 2022
|
|
||||||
*/
|
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
GNU GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
|||||||
@@ -21,5 +21,5 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
@@ -1,16 +1,32 @@
|
|||||||
<!--
|
<!--
|
||||||
This README describes the package. If you publish this package to pub.dev,
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
this README's contents appear on the landing page for your package.
|
* Please see the AUTHORS file for details.
|
||||||
|
*
|
||||||
For information about how to write a good package README, see the guide for
|
* This program is free software: you can redistribute it and/or modify
|
||||||
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
For general information about developing packages, see the Dart guide for
|
* any later version.
|
||||||
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
|
*
|
||||||
and the Flutter guide for
|
* This program is distributed in the hope that it will be useful,
|
||||||
[developing packages and plugins](https://flutter.dev/developing-packages).
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# Dart - CLI Toolbox
|
||||||
|
|
||||||
|
<p align="left">
|
||||||
|
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis">
|
||||||
|
<img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" />
|
||||||
|
</a>
|
||||||
|
<img src="https://img.shields.io/badge/SDK-Dart-blue?style=flat-square" alt="SDK: Dart" />
|
||||||
|
<img src="https://img.shields.io/badge/Status-WIP-red?style=flat-square" alt="WIP" />
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
TODO: Put a short description of the package here that helps potential users
|
TODO: Put a short description of the package here that helps potential users
|
||||||
know whether this package might be useful for them.
|
know whether this package might be useful for them.
|
||||||
|
|
||||||
|
|||||||
@@ -10,6 +10,6 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
dependencies: {meta: ^1.8.0}
|
dependencies: {meta: ^1.8.0}
|
||||||
|
|||||||
@@ -23,5 +23,5 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
|
|||||||
@@ -16,5 +16,5 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# Files and directories created by pub.
|
||||||
|
.dart_tool/
|
||||||
|
.packages
|
||||||
|
|
||||||
|
# Conventional directory for build outputs.
|
||||||
|
build/
|
||||||
|
|
||||||
|
# Omit committing pubspec.lock for library packages; see
|
||||||
|
# https://dart.dev/guides/libraries/private-files#pubspeclock.
|
||||||
|
pubspec.lock
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
|
* Please see the AUTHORS file for details.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"psioniq.psi-header",
|
||||||
|
"blaugold.melos-code"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
{
|
||||||
|
"psi-header.changes-tracking": {
|
||||||
|
"isActive": true
|
||||||
|
},
|
||||||
|
"psi-header.config": {
|
||||||
|
"blankLinesAfter": 1,
|
||||||
|
"forceToTop": true
|
||||||
|
},
|
||||||
|
"psi-header.lang-config": [
|
||||||
|
{
|
||||||
|
"beforeHeader": [
|
||||||
|
"# -*- coding:utf-8 -*-",
|
||||||
|
"#!/usr/bin/env python3"
|
||||||
|
],
|
||||||
|
"begin": "###",
|
||||||
|
"end": "###",
|
||||||
|
"language": "python",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"beforeHeader": [
|
||||||
|
"#!/usr/bin/env sh",
|
||||||
|
""
|
||||||
|
],
|
||||||
|
"language": "shellscript",
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"language": "dart",
|
||||||
|
"prefix": "// "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"language": "yaml",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "<!--",
|
||||||
|
"end": "-->",
|
||||||
|
"language": "markdown",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"psi-header.templates": [
|
||||||
|
{
|
||||||
|
"language": "*",
|
||||||
|
"template": [
|
||||||
|
"Copyright (C) <<year>> WYATT GROUP",
|
||||||
|
"Please see the AUTHORS file for details.",
|
||||||
|
"",
|
||||||
|
"This program is free software: you can redistribute it and/or modify",
|
||||||
|
"it under the terms of the GNU General Public License as published by",
|
||||||
|
"the Free Software Foundation, either version 3 of the License, or",
|
||||||
|
"any later version.",
|
||||||
|
"",
|
||||||
|
"This program is distributed in the hope that it will be useful,",
|
||||||
|
"but WITHOUT ANY WARRANTY; without even the implied warranty of",
|
||||||
|
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the",
|
||||||
|
"GNU General Public License for more details.",
|
||||||
|
"",
|
||||||
|
"You should have received a copy of the GNU General Public License",
|
||||||
|
"along with this program. If not, see <https://www.gnu.org/licenses/>."
|
||||||
|
],
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"dart.runPubGetOnPubspecChanges": false,
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Below is a list of people and organizations that have contributed
|
||||||
|
# to this project. Names should be added to the list like so:
|
||||||
|
#
|
||||||
|
# Name/Organization <email address>
|
||||||
|
|
||||||
|
Wyatt Group S.A.S
|
||||||
|
Hugo Pointcheval <git@pcl.ovh>
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
## 1.2.0
|
||||||
|
|
||||||
|
- **FEAT**: add new middleware feature.
|
||||||
|
- **FEAT**: implements doublelinked list for middlewares.
|
||||||
|
- **FEAT**: [WIP] implements middleware system.
|
||||||
|
- **FEAT**: [WIP] work on middleware feature.
|
||||||
|
|
||||||
|
## 1.1.0
|
||||||
|
|
||||||
|
- **FEAT**: add oauth2 refresh token client.
|
||||||
|
|
||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
- Initial version.
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,182 @@
|
|||||||
|
<!--
|
||||||
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
|
* Please see the AUTHORS file for details.
|
||||||
|
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Dart - HTTP Client
|
||||||
|
|
||||||
|
<p align="left">
|
||||||
|
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis">
|
||||||
|
<img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" />
|
||||||
|
</a>
|
||||||
|
<img src="https://img.shields.io/badge/SDK-Dart%20%7C%20Flutter-blue?style=flat-square" alt="SDK: Dart & Flutter" />
|
||||||
|
</p>
|
||||||
|
|
||||||
|
HTTP Client for Dart with Middlewares !
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
Simply add wyatt_http_client in pubspec.yaml, then
|
||||||
|
|
||||||
|
```dart
|
||||||
|
import 'package:wyatt_http_client/wyatt_http_client.dart';
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Firstly you have to understand **Middleware** and **Pipeline** concepts.
|
||||||
|
|
||||||
|
In `wyatt_http_client` a middleware is an object where requests and responses
|
||||||
|
pass through. And a pipeline is basicaly a list of middlewares.
|
||||||
|
|
||||||
|
In a pipeline with middlewares A and B, if request pass through A, then B,
|
||||||
|
the response will pass through B then A.
|
||||||
|
|
||||||
|
> You can `print(pipeline)` to get full process order of a pipeline.
|
||||||
|
|
||||||
|
For example, if you want to log every request, and simplify an url you can use provided `SimpleLogger` and `UriPrefix` .
|
||||||
|
|
||||||
|
```dart
|
||||||
|
// Create the Pipeline
|
||||||
|
final Pipeline pipeline = Pipeline()
|
||||||
|
.addMiddleware(
|
||||||
|
UriPrefixMiddleware(
|
||||||
|
protocol: Protocols.http,
|
||||||
|
authority: 'localhost:80',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(SimpleLoggerMiddleware());
|
||||||
|
```
|
||||||
|
|
||||||
|
Then if you print the pipeline,
|
||||||
|
|
||||||
|
```
|
||||||
|
[Req] -> UriPrefix -> SimpleLogger
|
||||||
|
[Res] -> SimpleLogger
|
||||||
|
```
|
||||||
|
|
||||||
|
> The `response` doesn't pass through `UriPrefix` because it's an `OnRequestMiddleware` only.
|
||||||
|
|
||||||
|
And you can create a client.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
final client = MiddlewareClient(pipeline: pipeline);
|
||||||
|
```
|
||||||
|
|
||||||
|
At this point you can use `client` like every Client from `package:http/http.dart` .
|
||||||
|
|
||||||
|
## Recipes
|
||||||
|
|
||||||
|
### Rest API with URL Authentication
|
||||||
|
|
||||||
|
Let's build a client for a REST API where the (bad) authentication is through the URL.
|
||||||
|
We need some middlewares:
|
||||||
|
|
||||||
|
* SimpleLogger, to log every request and response (useful for debug).
|
||||||
|
* BodyToJson, to automaticaly transform Map object to JSON.
|
||||||
|
* UriPrefix, to simplify the build of an API Object (save protocol and API prefix).
|
||||||
|
* UnsafeAuth, to use url based authentication.
|
||||||
|
|
||||||
|
Let's start by creating the Pipeline:
|
||||||
|
|
||||||
|
```dart
|
||||||
|
final Pipeline pipeline = Pipeline()
|
||||||
|
.addMiddleware(
|
||||||
|
UriPrefixMiddleware(
|
||||||
|
protocol: Protocols.http,
|
||||||
|
authority: 'localhost:80',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(BodyToJsonMiddleware())
|
||||||
|
.addMiddleware(
|
||||||
|
UnsafeAuthMiddleware(
|
||||||
|
username: 'wyatt',
|
||||||
|
password: 'motdepasse',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(SimpleLoggerMiddleware());
|
||||||
|
```
|
||||||
|
|
||||||
|
Then simply create a client and make a call.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
final client = MiddlewareClient(pipeline: pipeline);
|
||||||
|
|
||||||
|
await client.get(Uri.parse('/protected'));
|
||||||
|
```
|
||||||
|
|
||||||
|
> Here it make a `GET` call on `http://localhost:80/protected?username=wyatt&password=motdepasse`
|
||||||
|
|
||||||
|
And voilà.
|
||||||
|
|
||||||
|
### Rest API with Oauth2
|
||||||
|
|
||||||
|
So now we want a real authentication.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
final Pipeline pipeline = Pipeline()
|
||||||
|
.addMiddleware(
|
||||||
|
UriPrefixMiddleware(
|
||||||
|
protocol: Protocols.http,
|
||||||
|
authority: 'localhost:80',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(BodyToJsonMiddleware())
|
||||||
|
.addMiddleware(
|
||||||
|
RefreshTokenAuthMiddleware(
|
||||||
|
authorizationEndpoint: '/auth/sign-in',
|
||||||
|
tokenEndpoint: '/auth/refresh',
|
||||||
|
accessTokenParser: (body) => body['access_token']! as String,
|
||||||
|
refreshTokenParser: (body) => body['refresh_token']! as String,
|
||||||
|
unauthorized: HttpStatus.forbidden,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(SimpleLoggerMiddleware());
|
||||||
|
```
|
||||||
|
|
||||||
|
> Here we just change `UnsafeAuthMiddleware` by `RefreshTokenAuthMiddleware` and the whole app while adapt to a new authentication system.
|
||||||
|
|
||||||
|
### Create a new Middleware
|
||||||
|
|
||||||
|
You can create your own middleware by implementing `Middleware` class, and use mixins to add `OnRequest` and/or `OnResponse` methods.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
class SimpleLoggerMiddleware
|
||||||
|
with OnRequestMiddleware, OnResponseMiddleware
|
||||||
|
implements Middleware {
|
||||||
|
|
||||||
|
@override
|
||||||
|
String getName() => 'SimpleLogger';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
print('${getName()}::OnRequest');
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareResponse> onResponse(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareResponse response,
|
||||||
|
) async {
|
||||||
|
print('${getName()}::OnResponse');
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
include: package:wyatt_analysis/analysis_options.yaml
|
||||||
@@ -0,0 +1,294 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:async';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/wyatt_http_client.dart';
|
||||||
|
|
||||||
|
String lastToken = '';
|
||||||
|
int token = 0;
|
||||||
|
|
||||||
|
void printAuth(HttpRequest req) {
|
||||||
|
print(
|
||||||
|
'Authorization => '
|
||||||
|
"${req.headers.value('Authorization') ?? 'no authorization header'}",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> handleBasic(HttpRequest req) async {
|
||||||
|
printAuth(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> handleBasicNegotiate(HttpRequest req) async {
|
||||||
|
if (req.headers.value('Authorization') == null) {
|
||||||
|
req.response.statusCode = HttpStatus.unauthorized.statusCode;
|
||||||
|
req.response.headers.set(HeaderKeys.wwwAuthenticate, 'Basic realm="Wyatt"');
|
||||||
|
print(req.response.headers.value('WWW-Authenticate'));
|
||||||
|
return req.response.close();
|
||||||
|
}
|
||||||
|
printAuth(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> handleBearer(HttpRequest req) async {
|
||||||
|
printAuth(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> handleDigest(HttpRequest req) async {
|
||||||
|
if (req.headers.value('Authorization') == null) {
|
||||||
|
req.response.statusCode = HttpStatus.unauthorized.statusCode;
|
||||||
|
req.response.headers.set(
|
||||||
|
'WWW-Authenticate',
|
||||||
|
'Digest realm="Wyatt", '
|
||||||
|
'qop="auth,auth-int", '
|
||||||
|
'nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", '
|
||||||
|
'opaque="5ccc069c403ebaf9f0171e9517f40e41"',
|
||||||
|
);
|
||||||
|
print(req.response.headers.value('WWW-Authenticate'));
|
||||||
|
return req.response.close();
|
||||||
|
}
|
||||||
|
printAuth(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> handleUnsafe(HttpRequest req) async {
|
||||||
|
print(
|
||||||
|
'Query parameters => '
|
||||||
|
'${req.uri.queryParameters.toString()}',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> handleOauth2RefreshToken(HttpRequest req) async {
|
||||||
|
final action = req.uri.queryParameters['action'];
|
||||||
|
if (action == null) {
|
||||||
|
printAuth(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (action) {
|
||||||
|
case 'login':
|
||||||
|
if (req.method == 'POST') {
|
||||||
|
token++;
|
||||||
|
req.response.write(
|
||||||
|
'{"accessToken": "access-token-awesome$token", '
|
||||||
|
'"refreshToken": "refresh-token-awesome$token"}',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'refresh':
|
||||||
|
printAuth(req);
|
||||||
|
if (req.method == 'GET') {
|
||||||
|
token++;
|
||||||
|
req.response.write('{"accessToken": "access-token-refreshed$token"}');
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'access-denied':
|
||||||
|
final String receivedToken = req.headers.value('Authorization') ?? '';
|
||||||
|
if (receivedToken != '' &&
|
||||||
|
lastToken != '' &&
|
||||||
|
receivedToken != lastToken) {
|
||||||
|
lastToken = receivedToken;
|
||||||
|
printAuth(req);
|
||||||
|
return req.response.close();
|
||||||
|
} else {
|
||||||
|
lastToken = receivedToken;
|
||||||
|
req.response.statusCode = HttpStatus.unauthorized.statusCode;
|
||||||
|
return req.response.close();
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> server() async {
|
||||||
|
final server = await HttpServer.bind(InternetAddress.anyIPv6, 8080);
|
||||||
|
var error = 0;
|
||||||
|
var token = 0;
|
||||||
|
await server.forEach((HttpRequest request) {
|
||||||
|
print('[${request.method}] ${request.uri}');
|
||||||
|
switch (request.uri.path) {
|
||||||
|
case '/test/basic-test':
|
||||||
|
handleBasic(request);
|
||||||
|
break;
|
||||||
|
case '/test/basic-test-with-negotiate':
|
||||||
|
handleBasicNegotiate(request);
|
||||||
|
break;
|
||||||
|
case '/test/digest-test':
|
||||||
|
handleDigest(request);
|
||||||
|
break;
|
||||||
|
case '/test/apikey-test':
|
||||||
|
handleBearer(request);
|
||||||
|
break;
|
||||||
|
case '/test/bearer-test':
|
||||||
|
handleBearer(request);
|
||||||
|
break;
|
||||||
|
case '/test/unsafe-test':
|
||||||
|
handleUnsafe(request);
|
||||||
|
break;
|
||||||
|
case '/test/oauth2-test':
|
||||||
|
handleOauth2RefreshToken(request);
|
||||||
|
break;
|
||||||
|
|
||||||
|
case '/test/bearer-login':
|
||||||
|
if (request.method == 'POST') {
|
||||||
|
request.response.write('{"token": "access-token-test"}');
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case '/test/oauth2-test-error':
|
||||||
|
error++;
|
||||||
|
print('Error $error');
|
||||||
|
if (error >= 3) {
|
||||||
|
print('Authorized');
|
||||||
|
error = 0;
|
||||||
|
} else {
|
||||||
|
request.response.statusCode = HttpStatus.unauthorized.statusCode;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case '/test/oauth2-test-timeout':
|
||||||
|
error++;
|
||||||
|
print('Error $error');
|
||||||
|
request.response.statusCode = HttpStatus.unauthorized.statusCode;
|
||||||
|
break;
|
||||||
|
case '/test/oauth2-login':
|
||||||
|
if (request.method == 'POST') {
|
||||||
|
token++;
|
||||||
|
request.response.write(
|
||||||
|
'{"accessToken": "access-token-awesome$token", '
|
||||||
|
'"refreshToken": "refresh-token-awesome$token"}',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case '/test/oauth2-refresh':
|
||||||
|
print(
|
||||||
|
'Authorization => '
|
||||||
|
"${request.headers.value('Authorization') ?? 'no refresh token'}",
|
||||||
|
);
|
||||||
|
if (request.method == 'GET') {
|
||||||
|
token++;
|
||||||
|
request.response
|
||||||
|
.write('{"accessToken": "access-token-refreshed$token"}');
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case '/test/oauth2-refresh-error':
|
||||||
|
request.response.statusCode = HttpStatus.unauthorized.statusCode;
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
print(' => Unknown path or method');
|
||||||
|
request.response.statusCode = HttpStatus.notFound.statusCode;
|
||||||
|
}
|
||||||
|
request.response.close();
|
||||||
|
print('====================');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> main() async {
|
||||||
|
unawaited(server());
|
||||||
|
final base = 'localhost:8080';
|
||||||
|
final uriPrefix = UriPrefixMiddleware(
|
||||||
|
protocol: Protocols.http,
|
||||||
|
authority: base,
|
||||||
|
);
|
||||||
|
final jsonEncoder = BodyToJsonMiddleware();
|
||||||
|
final logger = SimpleLoggerMiddleware();
|
||||||
|
|
||||||
|
// Basic
|
||||||
|
final basicAuth = BasicAuthMiddleware(
|
||||||
|
username: 'username',
|
||||||
|
password: 'password',
|
||||||
|
);
|
||||||
|
final basic = MiddlewareClient(
|
||||||
|
pipeline: Pipeline.fromIterable([
|
||||||
|
uriPrefix,
|
||||||
|
basicAuth,
|
||||||
|
logger,
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
await basic.get(Uri.parse('/test/basic-test'));
|
||||||
|
|
||||||
|
// Digest
|
||||||
|
final digestAuth = DigestAuthMiddleware(
|
||||||
|
username: 'Mufasa',
|
||||||
|
password: 'Circle Of Life',
|
||||||
|
);
|
||||||
|
final digest = MiddlewareClient(
|
||||||
|
pipeline: Pipeline.fromIterable([
|
||||||
|
uriPrefix,
|
||||||
|
digestAuth,
|
||||||
|
logger,
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
await digest.get(Uri.parse('/test/digest-test'));
|
||||||
|
|
||||||
|
// // Bearer
|
||||||
|
// final bearer = BearerAuthenticationClient(
|
||||||
|
// token: 'access-token-test',
|
||||||
|
// inner: restClient,
|
||||||
|
// );
|
||||||
|
// await bearer.get(Uri.parse('/test/bearer-test'));
|
||||||
|
|
||||||
|
// // API Key
|
||||||
|
// final apiKey = BearerAuthenticationClient(
|
||||||
|
// token: 'awesome-api-key',
|
||||||
|
// authenticationMethod: 'ApiKey',
|
||||||
|
// inner: restClient,
|
||||||
|
// );
|
||||||
|
// await apiKey.get(Uri.parse('/test/apikey-test'));
|
||||||
|
|
||||||
|
// Unsafe URL
|
||||||
|
final unsafeAuth = UnsafeAuthMiddleware(
|
||||||
|
username: 'Mufasa',
|
||||||
|
password: 'Circle Of Life',
|
||||||
|
);
|
||||||
|
final unsafe = MiddlewareClient(
|
||||||
|
pipeline: Pipeline.fromIterable([
|
||||||
|
uriPrefix,
|
||||||
|
unsafeAuth,
|
||||||
|
logger,
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
await unsafe.get(Uri.parse('/test/unsafe-test'));
|
||||||
|
|
||||||
|
// OAuth2
|
||||||
|
final refreshTokenAuth = RefreshTokenAuthMiddleware(
|
||||||
|
authorizationEndpoint: '/test/oauth2-test?action=login',
|
||||||
|
tokenEndpoint: '/test/oauth2-test?action=refresh',
|
||||||
|
accessTokenParser: (body) => body['accessToken']! as String,
|
||||||
|
refreshTokenParser: (body) => body['refreshToken']! as String,
|
||||||
|
);
|
||||||
|
final refreshToken = MiddlewareClient(
|
||||||
|
pipeline: Pipeline.fromIterable([
|
||||||
|
uriPrefix,
|
||||||
|
jsonEncoder,
|
||||||
|
refreshTokenAuth,
|
||||||
|
logger,
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
await refreshToken.get(Uri.parse('/test/oauth2-test'));
|
||||||
|
// Login
|
||||||
|
await refreshToken.post(
|
||||||
|
Uri.parse('/test/oauth2-test'),
|
||||||
|
body: <String, String>{
|
||||||
|
'username': 'username',
|
||||||
|
'password': 'password',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
await refreshToken.get(Uri.parse('/test/oauth2-test'));
|
||||||
|
// await refreshToken.refresh();
|
||||||
|
// await refreshToken.get(Uri.parse('/test/oauth2-test'));
|
||||||
|
// await refreshToken.get(Uri.parse('/test/oauth2-test?action=access-denied'));
|
||||||
|
|
||||||
|
exit(0);
|
||||||
|
}
|
||||||
@@ -0,0 +1,398 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware_client.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/body_to_json_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/refresh_token_auth_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/simple_logger_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/uri_prefix_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/pipeline.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/http_status.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/protocols.dart';
|
||||||
|
|
||||||
|
enum EmailVerificationAction {
|
||||||
|
signUp,
|
||||||
|
resetPassword,
|
||||||
|
changeEmail;
|
||||||
|
|
||||||
|
String toSnakeCase() {
|
||||||
|
return name.splitMapJoin(
|
||||||
|
RegExp('[A-Z]'),
|
||||||
|
onMatch: (m) => '_${m[0]?.toLowerCase()}',
|
||||||
|
onNonMatch: (n) => n,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
factory EmailVerificationAction.fromString(String str) {
|
||||||
|
return EmailVerificationAction.values.firstWhere(
|
||||||
|
(EmailVerificationAction element) => element.toSnakeCase() == str,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class VerifyCode {
|
||||||
|
final String email;
|
||||||
|
final String verificationCode;
|
||||||
|
final EmailVerificationAction action;
|
||||||
|
VerifyCode({
|
||||||
|
required this.email,
|
||||||
|
required this.verificationCode,
|
||||||
|
required this.action,
|
||||||
|
});
|
||||||
|
|
||||||
|
VerifyCode copyWith({
|
||||||
|
String? email,
|
||||||
|
String? verificationCode,
|
||||||
|
EmailVerificationAction? action,
|
||||||
|
}) {
|
||||||
|
return VerifyCode(
|
||||||
|
email: email ?? this.email,
|
||||||
|
verificationCode: verificationCode ?? this.verificationCode,
|
||||||
|
action: action ?? this.action,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> toMap() {
|
||||||
|
return <String, dynamic>{
|
||||||
|
'email': email,
|
||||||
|
'verification_code': verificationCode,
|
||||||
|
'action': action.toSnakeCase(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
factory VerifyCode.fromMap(Map<String, dynamic> map) {
|
||||||
|
return VerifyCode(
|
||||||
|
email: map['email'] as String,
|
||||||
|
verificationCode: map['verification_code'] as String,
|
||||||
|
action: EmailVerificationAction.fromString(map['action'] as String),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
String toJson() => json.encode(toMap());
|
||||||
|
|
||||||
|
factory VerifyCode.fromJson(String source) =>
|
||||||
|
VerifyCode.fromMap(json.decode(source) as Map<String, dynamic>);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() =>
|
||||||
|
'VerifyCode(email: $email, verificationCode: $verificationCode, action: $action)';
|
||||||
|
}
|
||||||
|
|
||||||
|
class Account {
|
||||||
|
final String email;
|
||||||
|
final String? sessionId;
|
||||||
|
Account({
|
||||||
|
required this.email,
|
||||||
|
this.sessionId,
|
||||||
|
});
|
||||||
|
|
||||||
|
Account copyWith({
|
||||||
|
String? email,
|
||||||
|
String? sessionId,
|
||||||
|
}) {
|
||||||
|
return Account(
|
||||||
|
email: email ?? this.email,
|
||||||
|
sessionId: sessionId ?? this.sessionId,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> toMap() {
|
||||||
|
return <String, dynamic>{
|
||||||
|
'email': email,
|
||||||
|
'session_id': sessionId,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
factory Account.fromMap(Map<String, dynamic> map) {
|
||||||
|
return Account(
|
||||||
|
email: map['email'] as String,
|
||||||
|
sessionId: map['session_id'] != null ? map['session_id'] as String : null,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
String toJson() => json.encode(toMap());
|
||||||
|
|
||||||
|
factory Account.fromJson(String source) =>
|
||||||
|
Account.fromMap(json.decode(source) as Map<String, dynamic>);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() => 'Account(email: $email, sessionId: $sessionId)';
|
||||||
|
}
|
||||||
|
|
||||||
|
class SignUp {
|
||||||
|
final String sessionId;
|
||||||
|
final String password;
|
||||||
|
SignUp({
|
||||||
|
required this.sessionId,
|
||||||
|
required this.password,
|
||||||
|
});
|
||||||
|
|
||||||
|
SignUp copyWith({
|
||||||
|
String? sessionId,
|
||||||
|
String? password,
|
||||||
|
}) {
|
||||||
|
return SignUp(
|
||||||
|
sessionId: sessionId ?? this.sessionId,
|
||||||
|
password: password ?? this.password,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> toMap() {
|
||||||
|
return <String, dynamic>{
|
||||||
|
'session_id': sessionId,
|
||||||
|
'password': password,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
factory SignUp.fromMap(Map<String, dynamic> map) {
|
||||||
|
return SignUp(
|
||||||
|
sessionId: map['session_id'] as String,
|
||||||
|
password: map['password'] as String,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
String toJson() => json.encode(toMap());
|
||||||
|
|
||||||
|
factory SignUp.fromJson(String source) =>
|
||||||
|
SignUp.fromMap(json.decode(source) as Map<String, dynamic>);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() => 'SignUp(sessionId: $sessionId, password: $password)';
|
||||||
|
}
|
||||||
|
|
||||||
|
class TokenSuccess {
|
||||||
|
final String accessToken;
|
||||||
|
final String refreshToken;
|
||||||
|
final Account account;
|
||||||
|
TokenSuccess({
|
||||||
|
required this.accessToken,
|
||||||
|
required this.refreshToken,
|
||||||
|
required this.account,
|
||||||
|
});
|
||||||
|
|
||||||
|
TokenSuccess copyWith({
|
||||||
|
String? accessToken,
|
||||||
|
String? refreshToken,
|
||||||
|
Account? account,
|
||||||
|
}) {
|
||||||
|
return TokenSuccess(
|
||||||
|
accessToken: accessToken ?? this.accessToken,
|
||||||
|
refreshToken: refreshToken ?? this.refreshToken,
|
||||||
|
account: account ?? this.account,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> toMap() {
|
||||||
|
return <String, dynamic>{
|
||||||
|
'access_token': accessToken,
|
||||||
|
'refresh_token': refreshToken,
|
||||||
|
'account': account.toMap(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
factory TokenSuccess.fromMap(Map<String, dynamic> map) {
|
||||||
|
return TokenSuccess(
|
||||||
|
accessToken: map['access_token'] as String,
|
||||||
|
refreshToken: map['refresh_token'] as String,
|
||||||
|
account: Account.fromMap(map['account'] as Map<String, dynamic>),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
String toJson() => json.encode(toMap());
|
||||||
|
|
||||||
|
factory TokenSuccess.fromJson(String source) =>
|
||||||
|
TokenSuccess.fromMap(json.decode(source) as Map<String, dynamic>);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() =>
|
||||||
|
'TokenSuccess(accessToken: $accessToken, refreshToken: $refreshToken, account: $account)';
|
||||||
|
}
|
||||||
|
|
||||||
|
class Login {
|
||||||
|
final String email;
|
||||||
|
final String password;
|
||||||
|
Login({
|
||||||
|
required this.email,
|
||||||
|
required this.password,
|
||||||
|
});
|
||||||
|
|
||||||
|
Login copyWith({
|
||||||
|
String? email,
|
||||||
|
String? password,
|
||||||
|
}) {
|
||||||
|
return Login(
|
||||||
|
email: email ?? this.email,
|
||||||
|
password: password ?? this.password,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> toMap() {
|
||||||
|
return <String, dynamic>{
|
||||||
|
'email': email,
|
||||||
|
'password': password,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
factory Login.fromMap(Map<String, dynamic> map) {
|
||||||
|
return Login(
|
||||||
|
email: map['email'] as String,
|
||||||
|
password: map['password'] as String,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
String toJson() => json.encode(toMap());
|
||||||
|
|
||||||
|
factory Login.fromJson(String source) =>
|
||||||
|
Login.fromMap(json.decode(source) as Map<String, dynamic>);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() => 'Login(email: $email, password: $password)';
|
||||||
|
}
|
||||||
|
|
||||||
|
class FastAPI {
|
||||||
|
final String baseUrl;
|
||||||
|
final MiddlewareClient client;
|
||||||
|
final int apiVersion;
|
||||||
|
|
||||||
|
FastAPI({
|
||||||
|
this.baseUrl = 'localhost:80',
|
||||||
|
MiddlewareClient? client,
|
||||||
|
this.apiVersion = 1,
|
||||||
|
}) : client = client ?? MiddlewareClient();
|
||||||
|
|
||||||
|
String get apiPath => '/api/v$apiVersion';
|
||||||
|
|
||||||
|
Future<void> sendSignUpCode(String email) async {
|
||||||
|
final r = await client.post(
|
||||||
|
Uri.parse('$apiPath/auth/send-sign-up-code'),
|
||||||
|
body: <String, String>{
|
||||||
|
'email': email,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
if (r.statusCode != 201) {
|
||||||
|
throw Exception('Invalid reponse: ${r.statusCode}');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<Account> verifyCode(VerifyCode verifyCode) async {
|
||||||
|
final r = await client.post(
|
||||||
|
Uri.parse('$apiPath/auth/verify-code'),
|
||||||
|
body: verifyCode.toMap(),
|
||||||
|
);
|
||||||
|
if (r.statusCode != 202) {
|
||||||
|
throw Exception('Invalid reponse: ${r.statusCode}');
|
||||||
|
} else {
|
||||||
|
return Account.fromMap(
|
||||||
|
(jsonDecode(r.body) as Map<String, dynamic>)['account']
|
||||||
|
as Map<String, dynamic>,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<Account> signUp(SignUp signUp) async {
|
||||||
|
final r = await client.post(
|
||||||
|
Uri.parse('$apiPath/auth/sign-up'),
|
||||||
|
body: signUp.toMap(),
|
||||||
|
);
|
||||||
|
if (r.statusCode != 201) {
|
||||||
|
throw Exception('Invalid reponse: ${r.statusCode}');
|
||||||
|
} else {
|
||||||
|
return Account.fromJson(r.body);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<TokenSuccess> signInWithPassword(Login login) async {
|
||||||
|
final r = await client.post(
|
||||||
|
Uri.parse('$apiPath/auth/sign-in-with-password'),
|
||||||
|
body: login.toMap(),
|
||||||
|
);
|
||||||
|
if (r.statusCode != 200) {
|
||||||
|
throw Exception('Invalid reponse: ${r.statusCode}');
|
||||||
|
} else {
|
||||||
|
return TokenSuccess.fromJson(r.body);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Future<TokenSuccess> refresh() async {
|
||||||
|
// final r = await client.refresh();
|
||||||
|
// return TokenSuccess.fromJson(r?.body ?? '');
|
||||||
|
// }
|
||||||
|
|
||||||
|
Future<List<Account>> getAccountList() async {
|
||||||
|
final r = await client.get(
|
||||||
|
Uri.parse('$apiPath/account'),
|
||||||
|
);
|
||||||
|
if (r.statusCode != 200) {
|
||||||
|
throw Exception('Invalid reponse: ${r.statusCode}');
|
||||||
|
} else {
|
||||||
|
final list = (jsonDecode(r.body) as Map<String, dynamic>)['founds']
|
||||||
|
as List<Map<String, dynamic>>;
|
||||||
|
final result = <Account>[];
|
||||||
|
for (final element in list) {
|
||||||
|
result.add(Account.fromMap(element));
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void main(List<String> args) async {
|
||||||
|
final Pipeline pipeline = Pipeline()
|
||||||
|
.addMiddleware(
|
||||||
|
UriPrefixMiddleware(
|
||||||
|
protocol: Protocols.http,
|
||||||
|
authority: 'localhost:80',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(BodyToJsonMiddleware())
|
||||||
|
.addMiddleware(
|
||||||
|
RefreshTokenAuthMiddleware(
|
||||||
|
authorizationEndpoint: '/api/v1/auth/sign-in-with-password',
|
||||||
|
tokenEndpoint: '/api/v1/auth/refresh',
|
||||||
|
accessTokenParser: (body) => body['access_token']! as String,
|
||||||
|
refreshTokenParser: (body) => body['refresh_token']! as String,
|
||||||
|
unauthorized: HttpStatus.forbidden,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(SimpleLoggerMiddleware());
|
||||||
|
|
||||||
|
print(pipeline);
|
||||||
|
final client = MiddlewareClient(pipeline: pipeline);
|
||||||
|
|
||||||
|
final api = FastAPI(
|
||||||
|
client: client,
|
||||||
|
);
|
||||||
|
|
||||||
|
await api.sendSignUpCode('git@pcl.ovh');
|
||||||
|
final verifiedAccount = await api.verifyCode(
|
||||||
|
VerifyCode(
|
||||||
|
email: 'git@pcl.ovh',
|
||||||
|
verificationCode: '000000000',
|
||||||
|
action: EmailVerificationAction.signUp,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
final registeredAccount = await api.signUp(
|
||||||
|
SignUp(sessionId: verifiedAccount.sessionId ?? '', password: 'password'),
|
||||||
|
);
|
||||||
|
final signedInAccount = await api.signInWithPassword(
|
||||||
|
Login(email: 'git@pcl.ovh', password: 'password'),
|
||||||
|
);
|
||||||
|
final accountList = await api.getAccountList();
|
||||||
|
print(accountList);
|
||||||
|
}
|
||||||
@@ -0,0 +1,162 @@
|
|||||||
|
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware_client.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/body_to_json_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/simple_logger_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/unsafe_auth_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middlewares/uri_prefix_middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/pipeline.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/protocols.dart';
|
||||||
|
|
||||||
|
// class RequestMutatorMiddleware implements Middleware {
|
||||||
|
// @override
|
||||||
|
// Middleware? parent;
|
||||||
|
|
||||||
|
// @override
|
||||||
|
// Middleware? child;
|
||||||
|
|
||||||
|
// RequestMutatorMiddleware({
|
||||||
|
// this.parent,
|
||||||
|
// this.child,
|
||||||
|
// });
|
||||||
|
|
||||||
|
// @override
|
||||||
|
// BaseRequest onRequest(BaseRequest request) {
|
||||||
|
// print('RequestMutator::OnRequest: ${request.method} -> ${request.url}');
|
||||||
|
// return child?.onRequest(request) ?? request;
|
||||||
|
// }
|
||||||
|
|
||||||
|
// @override
|
||||||
|
// BaseResponse onResponse(BaseResponse response) {
|
||||||
|
// final res = child?.onResponse(response) ?? response;
|
||||||
|
// print(
|
||||||
|
// 'RequestMutator::OnResponse: ${res.statusCode} -> ${res.contentLength} bytes',
|
||||||
|
// );
|
||||||
|
// return res;
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
|
||||||
|
// typedef Middleware = Handler Function(Handler innerHandler);
|
||||||
|
|
||||||
|
// Middleware createMiddleware({
|
||||||
|
// FutureOr<Response?> Function(Request)? requestHandler,
|
||||||
|
// FutureOr<Response> Function(Response)? responseHandler,
|
||||||
|
// FutureOr<Response> Function(Object error, StackTrace)? errorHandler,
|
||||||
|
// }) {
|
||||||
|
// requestHandler ??= (request) => null;
|
||||||
|
// responseHandler ??= (response) => response;
|
||||||
|
|
||||||
|
// FutureOr<Response> Function(Object, StackTrace)? onError;
|
||||||
|
// if (errorHandler != null) {
|
||||||
|
// onError = (error, stackTrace) {
|
||||||
|
// if (error is Exception) throw error;
|
||||||
|
// return errorHandler(error, stackTrace);
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
|
||||||
|
// return (Handler innerHandler) {
|
||||||
|
// return (request) {
|
||||||
|
// return Future.sync(() => requestHandler!(request)).then((response) {
|
||||||
|
// if (response != null) return response;
|
||||||
|
|
||||||
|
// return Future.sync(() => innerHandler(request))
|
||||||
|
// .then((response) => responseHandler!(response), onError: onError);
|
||||||
|
// });
|
||||||
|
// };
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
|
||||||
|
// extension MiddlewareX on Middleware {
|
||||||
|
// Middleware addMiddleware(Middleware other) =>
|
||||||
|
// (Handler handler) => this(other(handler));
|
||||||
|
// Handler addHandler(Handler handler) => this(handler);
|
||||||
|
// }
|
||||||
|
|
||||||
|
// typedef Handler = FutureOr<Response> Function(Request request);
|
||||||
|
|
||||||
|
// final headerMutator = createMiddleware(
|
||||||
|
// responseHandler: (response) {
|
||||||
|
// print(response.headers);
|
||||||
|
// return response;
|
||||||
|
// },);
|
||||||
|
|
||||||
|
// class Pipeline {
|
||||||
|
// const Pipeline();
|
||||||
|
|
||||||
|
// Pipeline addMiddleware(Middleware middleware) =>
|
||||||
|
// _Pipeline(middleware, addHandler);
|
||||||
|
|
||||||
|
// Handler addHandler(Handler handler) => handler;
|
||||||
|
|
||||||
|
// Middleware get middleware => addHandler;
|
||||||
|
// }
|
||||||
|
|
||||||
|
// class _Pipeline extends Pipeline {
|
||||||
|
// final Middleware _middleware;
|
||||||
|
// final Middleware _parent;
|
||||||
|
|
||||||
|
// _Pipeline(this._middleware, this._parent);
|
||||||
|
|
||||||
|
// @override
|
||||||
|
// Handler addHandler(Handler handler) => _parent(_middleware(handler));
|
||||||
|
// }
|
||||||
|
|
||||||
|
Future<void> main(List<String> args) async {
|
||||||
|
final UnsafeAuthMiddleware auth = UnsafeAuthMiddleware();
|
||||||
|
final Pipeline pipeline = Pipeline()
|
||||||
|
.addMiddleware(
|
||||||
|
UriPrefixMiddleware(
|
||||||
|
protocol: Protocols.http,
|
||||||
|
authority: 'localhost:80',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(BodyToJsonMiddleware())
|
||||||
|
.addMiddleware(
|
||||||
|
UnsafeAuthMiddleware(
|
||||||
|
username: 'wyatt',
|
||||||
|
password: 'motdepasse',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.addMiddleware(SimpleLoggerMiddleware());
|
||||||
|
// .addMiddleware(
|
||||||
|
// RefreshTokenMiddleware(
|
||||||
|
// authorizationEndpoint: '/api/v1/account/test?action=authorize',
|
||||||
|
// tokenEndpoint: '/api/v1/account/test?action=refresh',
|
||||||
|
// accessTokenParser: (body) => body['access_token']! as String,
|
||||||
|
// refreshTokenParser: (body) => body['refresh_token']! as String,
|
||||||
|
// ),
|
||||||
|
// );
|
||||||
|
|
||||||
|
print(pipeline);
|
||||||
|
final client = MiddlewareClient(pipeline: pipeline);
|
||||||
|
await client.post(
|
||||||
|
Uri.parse('/api/v1/account/test'),
|
||||||
|
body: <String, String>{
|
||||||
|
'email': 'test@test.fr',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
auth
|
||||||
|
..username = 'username'
|
||||||
|
..password = 'password';
|
||||||
|
await client.post(
|
||||||
|
Uri.parse('/api/v1/account/test'),
|
||||||
|
body: <String, String>{
|
||||||
|
'email': 'test@test.fr',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
|
||||||
|
abstract class Middleware {
|
||||||
|
Middleware();
|
||||||
|
String getName();
|
||||||
|
}
|
||||||
|
|
||||||
|
mixin OnRequestMiddleware {
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
mixin OnResponseMiddleware {
|
||||||
|
Future<MiddlewareResponse> onResponse(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareResponse response,
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:http/http.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/unfreezed_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/pipeline.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/http_methods.dart';
|
||||||
|
|
||||||
|
class MiddlewareClient extends BaseClient {
|
||||||
|
final Client inner;
|
||||||
|
final Pipeline pipeline;
|
||||||
|
|
||||||
|
MiddlewareClient({
|
||||||
|
Pipeline? pipeline,
|
||||||
|
Client? inner,
|
||||||
|
}) : pipeline = pipeline ?? Pipeline(),
|
||||||
|
inner = inner ?? Client() {
|
||||||
|
print('Using Pipeline:\n$pipeline');
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<Response> head(Uri url, {Map<String, String>? headers}) =>
|
||||||
|
_sendUnstreamed(HttpMethods.head.method, url, headers);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<Response> get(Uri url, {Map<String, String>? headers}) =>
|
||||||
|
_sendUnstreamed(HttpMethods.get.method, url, headers);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<Response> post(
|
||||||
|
Uri url, {
|
||||||
|
Map<String, String>? headers,
|
||||||
|
Object? body,
|
||||||
|
Encoding? encoding,
|
||||||
|
}) =>
|
||||||
|
_sendUnstreamed(HttpMethods.post.method, url, headers, body, encoding);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<Response> put(
|
||||||
|
Uri url, {
|
||||||
|
Map<String, String>? headers,
|
||||||
|
Object? body,
|
||||||
|
Encoding? encoding,
|
||||||
|
}) =>
|
||||||
|
_sendUnstreamed(HttpMethods.put.method, url, headers, body, encoding);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<Response> patch(
|
||||||
|
Uri url, {
|
||||||
|
Map<String, String>? headers,
|
||||||
|
Object? body,
|
||||||
|
Encoding? encoding,
|
||||||
|
}) =>
|
||||||
|
_sendUnstreamed(HttpMethods.patch.method, url, headers, body, encoding);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<Response> delete(
|
||||||
|
Uri url, {
|
||||||
|
Map<String, String>? headers,
|
||||||
|
Object? body,
|
||||||
|
Encoding? encoding,
|
||||||
|
}) =>
|
||||||
|
_sendUnstreamed(HttpMethods.delete.method, url, headers, body, encoding);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<StreamedResponse> send(BaseRequest request) {
|
||||||
|
return inner.send(request);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<Response> _sendUnstreamed(
|
||||||
|
String method,
|
||||||
|
Uri url,
|
||||||
|
Map<String, String>? headers, [
|
||||||
|
Object? body,
|
||||||
|
Encoding? encoding,
|
||||||
|
]) async {
|
||||||
|
final originalRequest = MiddlewareRequest(
|
||||||
|
unfreezedRequest: UnfreezedRequest(
|
||||||
|
method: method,
|
||||||
|
url: url,
|
||||||
|
headers: headers,
|
||||||
|
body: body,
|
||||||
|
encoding: encoding,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
final requestContext = MiddlewareContext(
|
||||||
|
pipeline: pipeline,
|
||||||
|
client: this,
|
||||||
|
originalRequest: originalRequest,
|
||||||
|
);
|
||||||
|
|
||||||
|
final modifiedRequest = await pipeline.onRequest(
|
||||||
|
requestContext,
|
||||||
|
originalRequest.copyWith(),
|
||||||
|
);
|
||||||
|
|
||||||
|
final originalResponse = MiddlewareResponse(
|
||||||
|
httpResponse: await Response.fromStream(
|
||||||
|
await send(modifiedRequest.request),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
final responseContext =
|
||||||
|
requestContext.copyWith(originalResponse: originalResponse);
|
||||||
|
|
||||||
|
final modifiedResponse =
|
||||||
|
await pipeline.onResponse(responseContext, originalResponse.copyWith());
|
||||||
|
|
||||||
|
return modifiedResponse.httpResponse as Response;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/authentication_methods.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/header_keys.dart';
|
||||||
|
|
||||||
|
class BasicAuthMiddleware with OnRequestMiddleware implements Middleware {
|
||||||
|
String? username;
|
||||||
|
String? password;
|
||||||
|
final String authenticationHeader;
|
||||||
|
|
||||||
|
BasicAuthMiddleware({
|
||||||
|
this.username,
|
||||||
|
this.password,
|
||||||
|
this.authenticationHeader = HeaderKeys.authorization,
|
||||||
|
});
|
||||||
|
|
||||||
|
@override
|
||||||
|
String getName() => 'BasicAuth';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
if (username == null || password == null) {
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> Basic: ${base64Encode(utf8.encode('$username:$password'))}',
|
||||||
|
);
|
||||||
|
final mutation = {
|
||||||
|
authenticationHeader: '${AuthenticationMethods.basic} '
|
||||||
|
'${base64Encode(utf8.encode('$username:$password'))}',
|
||||||
|
};
|
||||||
|
final Map<String, String> headers = request.headers..addAll(mutation);
|
||||||
|
request.modifyRequest(request.unfreezedRequest.copyWith(headers: headers));
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
|
||||||
|
class BodyToJsonMiddleware with OnRequestMiddleware implements Middleware {
|
||||||
|
@override
|
||||||
|
String getName() => 'BodyToJson';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> Transforms body in json if Map then update '
|
||||||
|
'headers with right content-type',
|
||||||
|
);
|
||||||
|
final mutation = {
|
||||||
|
'content-type': 'application/json; charset=utf-8',
|
||||||
|
};
|
||||||
|
if (request.body is Map) {
|
||||||
|
final Map<String, String> headers = request.headers..addAll(mutation);
|
||||||
|
request.modifyRequest(
|
||||||
|
request.unfreezedRequest
|
||||||
|
.copyWith(headers: headers, body: jsonEncode(request.body)),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
|
||||||
|
class DefaultMiddleware implements Middleware {
|
||||||
|
@override
|
||||||
|
String getName() => 'DefaultMiddleware';
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/digest_auth.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/header_keys.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/http_status.dart';
|
||||||
|
|
||||||
|
class DigestAuthMiddleware
|
||||||
|
with OnRequestMiddleware, OnResponseMiddleware
|
||||||
|
implements Middleware {
|
||||||
|
final String username;
|
||||||
|
final String password;
|
||||||
|
final DigestAuth _digestAuth;
|
||||||
|
final String authenticationHeader;
|
||||||
|
final String wwwAuthenticateHeader;
|
||||||
|
final HttpStatus unauthorized;
|
||||||
|
|
||||||
|
DigestAuthMiddleware({
|
||||||
|
required this.username,
|
||||||
|
required this.password,
|
||||||
|
this.authenticationHeader = HeaderKeys.authorization,
|
||||||
|
this.wwwAuthenticateHeader = HeaderKeys.wwwAuthenticate,
|
||||||
|
this.unauthorized = HttpStatus.unauthorized,
|
||||||
|
}) : _digestAuth = DigestAuth(username, password);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String getName() => 'DigestAuth';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> Digest ready: ${_digestAuth.isReady()}',
|
||||||
|
);
|
||||||
|
if (_digestAuth.isReady()) {
|
||||||
|
final mutation = {
|
||||||
|
authenticationHeader: _digestAuth.getAuthString(
|
||||||
|
request.method,
|
||||||
|
request.url,
|
||||||
|
),
|
||||||
|
};
|
||||||
|
final Map<String, String> headers = request.headers..addAll(mutation);
|
||||||
|
request
|
||||||
|
.modifyRequest(request.unfreezedRequest.copyWith(headers: headers));
|
||||||
|
}
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareResponse> onResponse(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareResponse response,
|
||||||
|
) async {
|
||||||
|
if (response.status == unauthorized) {
|
||||||
|
final authInfo =
|
||||||
|
response.headers[HeaderKeys.wwwAuthenticate.toLowerCase()];
|
||||||
|
_digestAuth.initFromAuthenticateHeader(authInfo);
|
||||||
|
|
||||||
|
final MiddlewareRequest? newRequest = context.lastRequest?.copyWith();
|
||||||
|
|
||||||
|
if (newRequest != null) {
|
||||||
|
final newResponse = await context.client.send(newRequest.request);
|
||||||
|
return MiddlewareResponse(httpResponse: newResponse);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
print(
|
||||||
|
'${getName()}::OnResponse\n'
|
||||||
|
'>> Digest ready: ${_digestAuth.isReady()}',
|
||||||
|
);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
export 'access_token_auth_middleware.dart';
|
||||||
|
export 'basic_auth_middleware.dart';
|
||||||
|
export 'body_to_json_middleware.dart';
|
||||||
|
export 'default_middleware.dart';
|
||||||
|
export 'digest_auth_middleware.dart';
|
||||||
|
export 'refresh_token_auth_middleware.dart';
|
||||||
|
export 'simple_logger_middleware.dart';
|
||||||
|
export 'unsafe_auth_middleware.dart';
|
||||||
|
export 'uri_prefix_middleware.dart';
|
||||||
@@ -0,0 +1,191 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/middleware_client.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/authentication_methods.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/delay.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/header_keys.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/http_status.dart';
|
||||||
|
|
||||||
|
typedef TokenParser = String Function(Map<String, dynamic>);
|
||||||
|
|
||||||
|
class RefreshTokenAuthMiddleware
|
||||||
|
with OnRequestMiddleware, OnResponseMiddleware
|
||||||
|
implements Middleware {
|
||||||
|
final String authorizationEndpoint;
|
||||||
|
final String tokenEndpoint;
|
||||||
|
|
||||||
|
String? accessToken;
|
||||||
|
final TokenParser accessTokenParser;
|
||||||
|
String? refreshToken;
|
||||||
|
final TokenParser refreshTokenParser;
|
||||||
|
|
||||||
|
final String authenticationHeader;
|
||||||
|
final String authenticationMethod;
|
||||||
|
final HttpStatus unauthorized;
|
||||||
|
final int maxAttempts;
|
||||||
|
|
||||||
|
RefreshTokenAuthMiddleware({
|
||||||
|
required this.authorizationEndpoint,
|
||||||
|
required this.tokenEndpoint,
|
||||||
|
required this.accessTokenParser,
|
||||||
|
required this.refreshTokenParser,
|
||||||
|
this.authenticationHeader = HeaderKeys.authorization,
|
||||||
|
this.authenticationMethod = AuthenticationMethods.bearer,
|
||||||
|
this.unauthorized = HttpStatus.unauthorized,
|
||||||
|
this.maxAttempts = 8,
|
||||||
|
});
|
||||||
|
|
||||||
|
@override
|
||||||
|
String getName() => 'RefreshToken';
|
||||||
|
|
||||||
|
Future<MiddlewareRequest?> refresh(MiddlewareContext context) async {
|
||||||
|
final subPipeline = context.pipeline.sub(this);
|
||||||
|
final httpClient = MiddlewareClient(
|
||||||
|
pipeline: subPipeline,
|
||||||
|
inner: context.client.inner,
|
||||||
|
);
|
||||||
|
final headers = {
|
||||||
|
authenticationHeader: '$authenticationMethod $refreshToken',
|
||||||
|
};
|
||||||
|
final response = MiddlewareResponse(
|
||||||
|
httpResponse: await httpClient.get(
|
||||||
|
Uri.parse(tokenEndpoint),
|
||||||
|
headers: headers,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (response.status.isSuccess()) {
|
||||||
|
final body = jsonDecode(response.body) as Map<String, dynamic>;
|
||||||
|
accessToken = accessTokenParser(body);
|
||||||
|
|
||||||
|
// Then modify current request with accessToken
|
||||||
|
final mutation = {
|
||||||
|
authenticationHeader: '$authenticationMethod $accessToken',
|
||||||
|
};
|
||||||
|
final Map<String, String>? headers = context.lastRequest?.headers
|
||||||
|
?..addAll(mutation);
|
||||||
|
final newRequest = context.lastRequest?.copyWith(
|
||||||
|
unfreezedRequest:
|
||||||
|
context.lastRequest?.unfreezedRequest.copyWith(headers: headers),
|
||||||
|
);
|
||||||
|
|
||||||
|
return newRequest;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<MiddlewareRequest?> retry(MiddlewareContext context) async {
|
||||||
|
// Retry
|
||||||
|
int attempt = 1;
|
||||||
|
while (attempt <= maxAttempts) {
|
||||||
|
// Delayed before retry
|
||||||
|
await Future<void>.delayed(Delay.getRetryDelay(attempt));
|
||||||
|
|
||||||
|
final newRequest = await refresh(context);
|
||||||
|
if (newRequest != null) {
|
||||||
|
return newRequest;
|
||||||
|
}
|
||||||
|
attempt++;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> accessToken: $accessToken\n'
|
||||||
|
'>> refreshToken: $refreshToken',
|
||||||
|
);
|
||||||
|
// Check if it is authorization
|
||||||
|
if (context.originalRequest?.url == Uri.parse(authorizationEndpoint)) {
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
// Check if it is refresh
|
||||||
|
if (context.originalRequest?.url == Uri.parse(tokenEndpoint)) {
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
// If AccessToken not null then return request with authorization header
|
||||||
|
if (accessToken != null) {
|
||||||
|
final mutation = {
|
||||||
|
authenticationHeader: '$authenticationMethod $accessToken',
|
||||||
|
};
|
||||||
|
final Map<String, String> headers = request.headers..addAll(mutation);
|
||||||
|
request
|
||||||
|
.modifyRequest(request.unfreezedRequest.copyWith(headers: headers));
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
// If AccessToken is null BUT there is a refreshToken, then try refreshing
|
||||||
|
if (refreshToken != null) {
|
||||||
|
MiddlewareRequest? newRequest = await refresh(context);
|
||||||
|
newRequest ??= await retry(context);
|
||||||
|
return newRequest ?? request;
|
||||||
|
}
|
||||||
|
// Pass
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareResponse> onResponse(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareResponse response,
|
||||||
|
) async {
|
||||||
|
// Check if it is authorization
|
||||||
|
if (context.originalRequest?.url == Uri.parse(authorizationEndpoint)) {
|
||||||
|
// If success, then update tokens
|
||||||
|
if (response.status.isSuccess()) {
|
||||||
|
final body = jsonDecode(response.body) as Map<String, dynamic>;
|
||||||
|
final accessToken = accessTokenParser(body);
|
||||||
|
final refreshToken = refreshTokenParser(body);
|
||||||
|
|
||||||
|
if (accessToken.isNotEmpty) {
|
||||||
|
this.accessToken = accessToken;
|
||||||
|
}
|
||||||
|
if (refreshToken.isNotEmpty) {
|
||||||
|
this.refreshToken = refreshToken;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
print(
|
||||||
|
'${getName()}::OnResponse\n'
|
||||||
|
'>> accessToken: $accessToken\n'
|
||||||
|
'>> refreshToken: $refreshToken',
|
||||||
|
);
|
||||||
|
|
||||||
|
if (response.status == unauthorized) {
|
||||||
|
// Refresh
|
||||||
|
MiddlewareRequest? newRequest = await refresh(context);
|
||||||
|
newRequest ??= await retry(context);
|
||||||
|
|
||||||
|
if (newRequest != null) {
|
||||||
|
return response.copyWith(
|
||||||
|
httpResponse: await context.client.send(newRequest.request),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
|
||||||
|
class SimpleLoggerMiddleware
|
||||||
|
with OnRequestMiddleware, OnResponseMiddleware
|
||||||
|
implements Middleware {
|
||||||
|
@override
|
||||||
|
String getName() => 'SimpleLogger';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> ${request.method} ${request.url}\n'
|
||||||
|
'>> Headers: ${request.headers}\n>> Body: ${request.encodedBody}',
|
||||||
|
);
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareResponse> onResponse(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareResponse response,
|
||||||
|
) async {
|
||||||
|
print(
|
||||||
|
'${getName()}::OnResponse\n'
|
||||||
|
'>> Status: ${response.status.name.toUpperCase()}\n'
|
||||||
|
'>> Length: ${response.contentLength ?? '0'} bytes',
|
||||||
|
// '>> Body: ${response.body}',
|
||||||
|
);
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/convert.dart';
|
||||||
|
|
||||||
|
class UnsafeAuthMiddleware with OnRequestMiddleware implements Middleware {
|
||||||
|
String? username;
|
||||||
|
String? password;
|
||||||
|
|
||||||
|
final String usernameField;
|
||||||
|
final String passwordField;
|
||||||
|
|
||||||
|
UnsafeAuthMiddleware({
|
||||||
|
this.username,
|
||||||
|
this.password,
|
||||||
|
this.usernameField = 'username',
|
||||||
|
this.passwordField = 'password',
|
||||||
|
});
|
||||||
|
|
||||||
|
@override
|
||||||
|
String getName() => 'UnsafeAuth';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
if (username == null || password == null) {
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
final Uri uri =
|
||||||
|
request.url + '?$usernameField=$username&$passwordField=$password';
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> Append: ?$usernameField=$username&$passwordField=$password',
|
||||||
|
);
|
||||||
|
request.modifyRequest(request.unfreezedRequest.copyWith(url: uri));
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/protocols.dart';
|
||||||
|
|
||||||
|
class UriPrefixMiddleware with OnRequestMiddleware implements Middleware {
|
||||||
|
final Protocols protocol;
|
||||||
|
final String? authority;
|
||||||
|
|
||||||
|
UriPrefixMiddleware({
|
||||||
|
required this.protocol,
|
||||||
|
required this.authority,
|
||||||
|
});
|
||||||
|
|
||||||
|
@override
|
||||||
|
String getName() => 'UriPrefix';
|
||||||
|
|
||||||
|
@override
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
final Uri uri = Uri.parse('${protocol.scheme}$authority${request.url}');
|
||||||
|
print(
|
||||||
|
'${getName()}::OnRequest\n'
|
||||||
|
'>> From: ${request.url}\n'
|
||||||
|
'>> To: $uri',
|
||||||
|
);
|
||||||
|
request.modifyRequest(request.unfreezedRequest.copyWith(url: uri));
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware_client.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
import 'package:wyatt_http_client/src/pipeline.dart';
|
||||||
|
|
||||||
|
class MiddlewareContext {
|
||||||
|
Pipeline pipeline;
|
||||||
|
MiddlewareClient client;
|
||||||
|
MiddlewareRequest? originalRequest;
|
||||||
|
MiddlewareRequest? lastRequest;
|
||||||
|
MiddlewareResponse? originalResponse;
|
||||||
|
MiddlewareResponse? lastResponse;
|
||||||
|
|
||||||
|
MiddlewareContext({
|
||||||
|
required this.pipeline,
|
||||||
|
required this.client,
|
||||||
|
this.originalRequest,
|
||||||
|
this.lastRequest,
|
||||||
|
this.originalResponse,
|
||||||
|
this.lastResponse,
|
||||||
|
});
|
||||||
|
|
||||||
|
MiddlewareContext copyWith({
|
||||||
|
Pipeline? pipeline,
|
||||||
|
MiddlewareClient? client,
|
||||||
|
MiddlewareRequest? originalRequest,
|
||||||
|
MiddlewareRequest? lastRequest,
|
||||||
|
MiddlewareResponse? originalResponse,
|
||||||
|
MiddlewareResponse? lastResponse,
|
||||||
|
}) {
|
||||||
|
return MiddlewareContext(
|
||||||
|
pipeline: pipeline ?? this.pipeline,
|
||||||
|
client: client ?? this.client,
|
||||||
|
originalRequest: originalRequest ?? this.originalRequest,
|
||||||
|
lastRequest: lastRequest ?? this.lastRequest,
|
||||||
|
originalResponse: originalResponse ?? this.originalResponse,
|
||||||
|
lastResponse: lastResponse ?? this.lastResponse,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() {
|
||||||
|
return 'MiddlewareContext(pipeline: $pipeline, client: $client, originalRequest: $originalRequest, lastRequest: $lastRequest, originalResponse: $originalResponse, lastResponse: $lastResponse)';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:http/http.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/unfreezed_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/convert.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/request_utils.dart';
|
||||||
|
|
||||||
|
class MiddlewareRequest {
|
||||||
|
UnfreezedRequest unfreezedRequest;
|
||||||
|
Request _httpRequest;
|
||||||
|
|
||||||
|
Request get request => _httpRequest;
|
||||||
|
|
||||||
|
// Proxy
|
||||||
|
String get method => _httpRequest.method;
|
||||||
|
Uri get url => _httpRequest.url;
|
||||||
|
Map<String, String> get headers => _httpRequest.headers;
|
||||||
|
Encoding get encoding => _httpRequest.encoding;
|
||||||
|
String get encodedBody => _httpRequest.body;
|
||||||
|
Object? get body => unfreezedRequest.body;
|
||||||
|
|
||||||
|
MiddlewareRequest({
|
||||||
|
required this.unfreezedRequest,
|
||||||
|
}) : _httpRequest = Request(unfreezedRequest.method, unfreezedRequest.url);
|
||||||
|
|
||||||
|
MiddlewareRequest copyWith({
|
||||||
|
UnfreezedRequest? unfreezedRequest,
|
||||||
|
}) {
|
||||||
|
return MiddlewareRequest(
|
||||||
|
unfreezedRequest: unfreezedRequest ?? this.unfreezedRequest,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
void modifyRequest(UnfreezedRequest unfreezedRequest) {
|
||||||
|
String? _body;
|
||||||
|
if (unfreezedRequest.body != null) {
|
||||||
|
final body = unfreezedRequest.body;
|
||||||
|
if (body is String) {
|
||||||
|
_body = body;
|
||||||
|
} else if (body is List) {
|
||||||
|
_body = String.fromCharCodes(body.cast<int>());
|
||||||
|
} else if (body is Map) {
|
||||||
|
_body = Convert.mapToQuery(body.cast<String, String>());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_httpRequest = RequestUtils.copyRequestWith(
|
||||||
|
_httpRequest,
|
||||||
|
method: unfreezedRequest.method,
|
||||||
|
url: unfreezedRequest.url,
|
||||||
|
headers: unfreezedRequest.headers,
|
||||||
|
body: _body,
|
||||||
|
) as Request;
|
||||||
|
if (unfreezedRequest.encoding != null) {
|
||||||
|
_httpRequest.encoding = unfreezedRequest.encoding!;
|
||||||
|
}
|
||||||
|
this.unfreezedRequest = unfreezedRequest;
|
||||||
|
}
|
||||||
|
|
||||||
|
void apply() {
|
||||||
|
modifyRequest(unfreezedRequest);
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() => 'MiddlewareRequest(unfreezedRequest: $unfreezedRequest)';
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:http/http.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/http_status.dart';
|
||||||
|
|
||||||
|
class MiddlewareResponse {
|
||||||
|
BaseResponse httpResponse;
|
||||||
|
|
||||||
|
// Proxy
|
||||||
|
int get statusCode => httpResponse.statusCode;
|
||||||
|
HttpStatus get status => HttpStatus.from(statusCode);
|
||||||
|
String get body {
|
||||||
|
if (httpResponse is Response) {
|
||||||
|
return (httpResponse as Response).body;
|
||||||
|
} else {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
int? get contentLength => httpResponse.contentLength;
|
||||||
|
Map<String, String> get headers => httpResponse.headers;
|
||||||
|
|
||||||
|
MiddlewareResponse({
|
||||||
|
required this.httpResponse,
|
||||||
|
});
|
||||||
|
|
||||||
|
MiddlewareResponse copyWith({
|
||||||
|
BaseResponse? httpResponse,
|
||||||
|
}) {
|
||||||
|
return MiddlewareResponse(
|
||||||
|
httpResponse: httpResponse ?? this.httpResponse,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() =>
|
||||||
|
'MiddlewareResponse(httpResponse: $httpResponse)';
|
||||||
|
}
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
export 'middleware_context.dart';
|
||||||
|
export 'middleware_request.dart';
|
||||||
|
export 'middleware_response.dart';
|
||||||
|
export 'unfreezed_request.dart';
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
class UnfreezedRequest {
|
||||||
|
final String method;
|
||||||
|
final Uri url;
|
||||||
|
final Map<String, String>? headers;
|
||||||
|
final Object? body;
|
||||||
|
final Encoding? encoding;
|
||||||
|
|
||||||
|
UnfreezedRequest({
|
||||||
|
required this.method,
|
||||||
|
required this.url,
|
||||||
|
this.headers,
|
||||||
|
this.body,
|
||||||
|
this.encoding,
|
||||||
|
});
|
||||||
|
|
||||||
|
UnfreezedRequest copyWith({
|
||||||
|
String? method,
|
||||||
|
Uri? url,
|
||||||
|
Map<String, String>? headers,
|
||||||
|
Object? body,
|
||||||
|
Encoding? encoding,
|
||||||
|
}) {
|
||||||
|
return UnfreezedRequest(
|
||||||
|
method: method ?? this.method,
|
||||||
|
url: url ?? this.url,
|
||||||
|
headers: headers ?? this.headers,
|
||||||
|
body: body ?? this.body,
|
||||||
|
encoding: encoding ?? this.encoding,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() {
|
||||||
|
return 'UnfreezedRequest(method: $method, url: $url, headers: '
|
||||||
|
'$headers, body: $body, encoding: $encoding)';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/middleware.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_context.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_request.dart';
|
||||||
|
import 'package:wyatt_http_client/src/models/middleware_response.dart';
|
||||||
|
|
||||||
|
class Pipeline {
|
||||||
|
final List<Middleware> _middlewares;
|
||||||
|
|
||||||
|
int get length => _middlewares.length;
|
||||||
|
|
||||||
|
Pipeline() : _middlewares = <Middleware>[];
|
||||||
|
Pipeline.fromIterable(Iterable<Middleware> middlewares)
|
||||||
|
: _middlewares = middlewares.toList();
|
||||||
|
|
||||||
|
/// Add a [Middleware] to this [Pipeline]
|
||||||
|
Pipeline addMiddleware(Middleware middleware) {
|
||||||
|
_middlewares.add(middleware);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create new [Pipeline] from the start or end to a specified [Middleware].
|
||||||
|
Pipeline sub(
|
||||||
|
Middleware middleware, {
|
||||||
|
bool include = false,
|
||||||
|
bool fromEnd = false,
|
||||||
|
}) {
|
||||||
|
final nodes = <Middleware>[];
|
||||||
|
final list = fromEnd ? _middlewares.reversed : _middlewares;
|
||||||
|
for (final m in list) {
|
||||||
|
if (m != middleware) {
|
||||||
|
nodes.add(m);
|
||||||
|
}
|
||||||
|
if (m == middleware) {
|
||||||
|
if (include) {
|
||||||
|
nodes.add(m);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Pipeline.fromIterable(fromEnd ? nodes.reversed : nodes);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<MiddlewareRequest> onRequest(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareRequest request,
|
||||||
|
) async {
|
||||||
|
print('\n\nNEW REQUEST\n');
|
||||||
|
MiddlewareRequest req = request..apply();
|
||||||
|
MiddlewareContext ctx = context.copyWith(lastRequest: req);
|
||||||
|
for (final middleware in _middlewares) {
|
||||||
|
if (middleware is OnRequestMiddleware) {
|
||||||
|
req = await (middleware as OnRequestMiddleware)
|
||||||
|
.onRequest(ctx, request);
|
||||||
|
ctx = context.copyWith(lastRequest: req);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return req;
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<MiddlewareResponse> onResponse(
|
||||||
|
MiddlewareContext context,
|
||||||
|
MiddlewareResponse response,
|
||||||
|
) async {
|
||||||
|
print('\n\nNEW RESPONSE\n');
|
||||||
|
MiddlewareResponse res = response;
|
||||||
|
MiddlewareContext ctx = context.copyWith(lastResponse: res);
|
||||||
|
for (final middleware in _middlewares.reversed) {
|
||||||
|
if (middleware is OnResponseMiddleware) {
|
||||||
|
res = await (middleware as OnResponseMiddleware)
|
||||||
|
.onResponse(ctx, response);
|
||||||
|
ctx = context.copyWith(lastResponse: res);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() {
|
||||||
|
final req = <String>[];
|
||||||
|
final res = <String>[];
|
||||||
|
for (final middleware in _middlewares) {
|
||||||
|
if (middleware is OnRequestMiddleware) {
|
||||||
|
req.add(middleware.getName());
|
||||||
|
}
|
||||||
|
if (middleware is OnResponseMiddleware) {
|
||||||
|
res.insert(0, middleware.getName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return '[Req] -> ${req.join(' -> ')}\n[Res] -> ${res.join(' -> ')}';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
abstract class AuthenticationMethods {
|
||||||
|
static const String basic = 'Basic';
|
||||||
|
static const String bearer = 'Bearer';
|
||||||
|
static const String digest = 'Digest';
|
||||||
|
}
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
class Convert {
|
||||||
|
static String toHex(List<int> bytes, {bool upperCase = false}) {
|
||||||
|
final buffer = StringBuffer();
|
||||||
|
for (final int part in bytes) {
|
||||||
|
if (part & 0xff != part) {
|
||||||
|
throw FormatException('Non-byte integer detected');
|
||||||
|
}
|
||||||
|
buffer.write('${part < 16 ? '0' : ''}${part.toRadixString(16)}');
|
||||||
|
}
|
||||||
|
if (upperCase) {
|
||||||
|
return buffer.toString().toUpperCase();
|
||||||
|
} else {
|
||||||
|
return buffer.toString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static String mapToQuery(Map<String, String> map, {Encoding? encoding}) {
|
||||||
|
final pairs = <List<String>>[];
|
||||||
|
map.forEach((key, value) => pairs.add([
|
||||||
|
Uri.encodeQueryComponent(key, encoding: encoding ?? utf8),
|
||||||
|
Uri.encodeQueryComponent(value, encoding: encoding ?? utf8)
|
||||||
|
]),);
|
||||||
|
return pairs.map((pair) => '${pair[0]}=${pair[1]}').join('&');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
extension UriX on Uri {
|
||||||
|
Uri operator +(String path) {
|
||||||
|
final thisPath = toString();
|
||||||
|
return Uri.parse(thisPath + path);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
|
||||||
|
import 'package:crypto/crypto.dart';
|
||||||
|
|
||||||
|
class Crypto {
|
||||||
|
/// Hash a string using MD5
|
||||||
|
static String md5Hash(String data) {
|
||||||
|
final content = Utf8Encoder().convert(data);
|
||||||
|
final md5Crypto = md5;
|
||||||
|
final digest = md5Crypto.convert(content).toString();
|
||||||
|
return digest;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:core';
|
||||||
|
import 'dart:math';
|
||||||
|
|
||||||
|
abstract class Delay {
|
||||||
|
static Duration getRetryDelay(int attempt) {
|
||||||
|
assert(attempt >= 0, 'attempt cannot be negative');
|
||||||
|
if (attempt <= 0) {
|
||||||
|
return Duration.zero;
|
||||||
|
}
|
||||||
|
final rand = Random();
|
||||||
|
final Duration delayFactor = const Duration(milliseconds: 200);
|
||||||
|
final double randomizationFactor = 0.25;
|
||||||
|
final Duration maxDelay = const Duration(seconds: 30);
|
||||||
|
|
||||||
|
final rf = randomizationFactor * (rand.nextDouble() * 2 - 1) + 1;
|
||||||
|
final exp = min(attempt, 31); // prevent overflows.
|
||||||
|
final delay = delayFactor * pow(2.0, exp) * rf;
|
||||||
|
return delay < maxDelay ? delay : maxDelay;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,198 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:math';
|
||||||
|
|
||||||
|
import 'package:wyatt_http_client/src/utils/convert.dart';
|
||||||
|
import 'package:wyatt_http_client/src/utils/crypto.dart';
|
||||||
|
|
||||||
|
class DigestAuth {
|
||||||
|
String username;
|
||||||
|
String password;
|
||||||
|
|
||||||
|
// must get from first response
|
||||||
|
String? _algorithm;
|
||||||
|
String? _qop;
|
||||||
|
String? _realm;
|
||||||
|
String? _nonce;
|
||||||
|
String? _opaque;
|
||||||
|
|
||||||
|
int _nc = 0; // request counter
|
||||||
|
|
||||||
|
DigestAuth(this.username, this.password);
|
||||||
|
|
||||||
|
/// Splits WWW-Authenticate header into a map.
|
||||||
|
Map<String, String>? splitWWWAuthenticateHeader(String header) {
|
||||||
|
if (!header.startsWith('Digest ')) {
|
||||||
|
throw ArgumentError.value(
|
||||||
|
header,
|
||||||
|
'header',
|
||||||
|
'Header must start with "Digest "',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
final h = header.substring(7); // remove 'Digest '
|
||||||
|
final ret = <String, String>{};
|
||||||
|
|
||||||
|
final components = h.split(',').map((token) => token.trim());
|
||||||
|
for (final component in components) {
|
||||||
|
final kv = component.split('=');
|
||||||
|
ret[kv[0]] = kv.getRange(1, kv.length).join('=').replaceAll('"', '');
|
||||||
|
}
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
String _computeNonce() {
|
||||||
|
final rnd = Random.secure();
|
||||||
|
final values = List<int>.generate(16, (i) => rnd.nextInt(256));
|
||||||
|
|
||||||
|
return Convert.toHex(values);
|
||||||
|
}
|
||||||
|
|
||||||
|
String _formatNonceCount(int nc) {
|
||||||
|
return nc.toRadixString(16).padLeft(8, '0');
|
||||||
|
}
|
||||||
|
|
||||||
|
String _computeHA1(
|
||||||
|
String realm,
|
||||||
|
String? algorithm,
|
||||||
|
String username,
|
||||||
|
String password,
|
||||||
|
String? nonce,
|
||||||
|
String? cnonce,
|
||||||
|
) {
|
||||||
|
if (algorithm == null || algorithm == 'MD5') {
|
||||||
|
final token1 = '$username:$realm:$password';
|
||||||
|
return Crypto.md5Hash(token1);
|
||||||
|
} else if (algorithm == 'MD5-sess') {
|
||||||
|
final token1 = '$username:$realm:$password';
|
||||||
|
final md51 = Crypto.md5Hash(token1);
|
||||||
|
final token2 = '$md51:$nonce:$cnonce';
|
||||||
|
return Crypto.md5Hash(token2);
|
||||||
|
} else {
|
||||||
|
throw ArgumentError.value(
|
||||||
|
algorithm,
|
||||||
|
'algorithm',
|
||||||
|
'Unsupported algorithm',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, String?> _computeResponse(
|
||||||
|
String method,
|
||||||
|
String path,
|
||||||
|
String body,
|
||||||
|
String? algorithm,
|
||||||
|
String? qop,
|
||||||
|
String? opaque,
|
||||||
|
String realm,
|
||||||
|
String? cnonce,
|
||||||
|
String? nonce,
|
||||||
|
int nc,
|
||||||
|
String username,
|
||||||
|
String password,
|
||||||
|
) {
|
||||||
|
final ret = <String, String?>{};
|
||||||
|
|
||||||
|
final ha1 =
|
||||||
|
_computeHA1(realm, algorithm, username, password, nonce, cnonce);
|
||||||
|
|
||||||
|
String ha2;
|
||||||
|
|
||||||
|
if (qop == 'auth-int') {
|
||||||
|
final bodyHash = Crypto.md5Hash(body);
|
||||||
|
final token2 = '$method:$path:$bodyHash';
|
||||||
|
ha2 = Crypto.md5Hash(token2);
|
||||||
|
} else {
|
||||||
|
// qop in [null, auth]
|
||||||
|
final token2 = '$method:$path';
|
||||||
|
ha2 = Crypto.md5Hash(token2);
|
||||||
|
}
|
||||||
|
|
||||||
|
final nonceCount = _formatNonceCount(nc);
|
||||||
|
ret['username'] = username;
|
||||||
|
ret['realm'] = realm;
|
||||||
|
ret['nonce'] = nonce;
|
||||||
|
ret['uri'] = path;
|
||||||
|
if (qop != null) {
|
||||||
|
ret['qop'] = qop;
|
||||||
|
}
|
||||||
|
ret['nc'] = nonceCount;
|
||||||
|
ret['cnonce'] = cnonce;
|
||||||
|
if (opaque != null) {
|
||||||
|
ret['opaque'] = opaque;
|
||||||
|
}
|
||||||
|
ret['algorithm'] = algorithm;
|
||||||
|
|
||||||
|
if (qop == null) {
|
||||||
|
final token3 = '$ha1:$nonce:$ha2';
|
||||||
|
ret['response'] = Crypto.md5Hash(token3);
|
||||||
|
} else if (qop == 'auth' || qop == 'auth-int') {
|
||||||
|
final token3 = '$ha1:$nonce:$nonceCount:$cnonce:$qop:$ha2';
|
||||||
|
ret['response'] = Crypto.md5Hash(token3);
|
||||||
|
}
|
||||||
|
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
String getAuthString(String method, Uri url) {
|
||||||
|
final _cnonce = _computeNonce();
|
||||||
|
_nc += 1;
|
||||||
|
// if url has query parameters, append query to path
|
||||||
|
final path = url.hasQuery ? '${url.path}?${url.query}' : url.path;
|
||||||
|
|
||||||
|
// after the first request we have the nonce, so we can provide credentials
|
||||||
|
final authValues = _computeResponse(
|
||||||
|
method,
|
||||||
|
path,
|
||||||
|
'',
|
||||||
|
_algorithm,
|
||||||
|
_qop,
|
||||||
|
_opaque,
|
||||||
|
_realm!,
|
||||||
|
_cnonce,
|
||||||
|
_nonce,
|
||||||
|
_nc,
|
||||||
|
username,
|
||||||
|
password,
|
||||||
|
);
|
||||||
|
final authValuesString = authValues.entries
|
||||||
|
.where((e) => e.value != null)
|
||||||
|
.map((e) => [e.key, '="', e.value, '"'].join())
|
||||||
|
.toList()
|
||||||
|
.join(', ');
|
||||||
|
final authString = 'Digest $authValuesString';
|
||||||
|
return authString;
|
||||||
|
}
|
||||||
|
|
||||||
|
void initFromAuthenticateHeader(String? authInfo) {
|
||||||
|
if (authInfo == null) {
|
||||||
|
throw ArgumentError.notNull('authInfo');
|
||||||
|
}
|
||||||
|
final values = splitWWWAuthenticateHeader(authInfo);
|
||||||
|
if (values != null) {
|
||||||
|
_algorithm = values['algorithm'] ?? _algorithm;
|
||||||
|
_qop = values['qop'] ?? _qop;
|
||||||
|
_realm = values['realm'] ?? _realm;
|
||||||
|
_nonce = values['nonce'] ?? _nonce;
|
||||||
|
_opaque = values['opaque'] ?? _opaque;
|
||||||
|
_nc = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool isReady() {
|
||||||
|
return _nonce != null && (_nc == 0 || _qop != null);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
abstract class HeaderKeys {
|
||||||
|
static const String authorization = 'Authorization';
|
||||||
|
static const String wwwAuthenticate = 'WWW-Authenticate';
|
||||||
|
static const String contentType = 'Content-Type';
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
enum HttpMethods {
|
||||||
|
head('HEAD'),
|
||||||
|
get('GET'),
|
||||||
|
post('POST'),
|
||||||
|
put('PUT'),
|
||||||
|
patch('PATCH'),
|
||||||
|
delete('DELETE');
|
||||||
|
|
||||||
|
final String method;
|
||||||
|
|
||||||
|
const HttpMethods(this.method);
|
||||||
|
}
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
/// Status codes for HTTP responses. Extracted from dart:io
|
||||||
|
enum HttpStatus {
|
||||||
|
continue_(100),
|
||||||
|
switchingProtocols(101),
|
||||||
|
processing(102),
|
||||||
|
ok(200),
|
||||||
|
created(201),
|
||||||
|
accepted(202),
|
||||||
|
nonAuthoritativeInformation(203),
|
||||||
|
noContent(204),
|
||||||
|
resetContent(205),
|
||||||
|
partialContent(206),
|
||||||
|
multiStatus(207),
|
||||||
|
alreadyReported(208),
|
||||||
|
imUsed(226),
|
||||||
|
multipleChoices(300),
|
||||||
|
movedPermanently(301),
|
||||||
|
found(302),
|
||||||
|
movedTemporarily(302), // Common alias for found.
|
||||||
|
seeOther(303),
|
||||||
|
notModified(304),
|
||||||
|
useProxy(305),
|
||||||
|
temporaryRedirect(307),
|
||||||
|
permanentRedirect(308),
|
||||||
|
badRequest(400),
|
||||||
|
unauthorized(401),
|
||||||
|
paymentRequired(402),
|
||||||
|
forbidden(403),
|
||||||
|
notFound(404),
|
||||||
|
methodNotAllowed(405),
|
||||||
|
notAcceptable(406),
|
||||||
|
proxyAuthenticationRequired(407),
|
||||||
|
requestTimeout(408),
|
||||||
|
conflict(409),
|
||||||
|
gone(410),
|
||||||
|
lengthRequired(411),
|
||||||
|
preconditionFailed(412),
|
||||||
|
requestEntityTooLarge(413),
|
||||||
|
requestUriTooLong(414),
|
||||||
|
unsupportedMediaType(415),
|
||||||
|
requestedRangeNotSatisfiable(416),
|
||||||
|
expectationFailed(417),
|
||||||
|
misdirectedRequest(421),
|
||||||
|
unprocessableEntity(422),
|
||||||
|
locked(423),
|
||||||
|
failedDependency(424),
|
||||||
|
upgradeRequired(426),
|
||||||
|
preconditionRequired(428),
|
||||||
|
tooManyRequests(429),
|
||||||
|
requestHeaderFieldsTooLarge(431),
|
||||||
|
connectionClosedWithoutResponse(444),
|
||||||
|
unavailableForLegalReasons(451),
|
||||||
|
clientClosedRequest(499),
|
||||||
|
internalServerError(500),
|
||||||
|
notImplemented(501),
|
||||||
|
badGateway(502),
|
||||||
|
serviceUnavailable(503),
|
||||||
|
gatewayTimeout(504),
|
||||||
|
httpVersionNotSupported(505),
|
||||||
|
variantAlsoNegotiates(506),
|
||||||
|
insufficientStorage(507),
|
||||||
|
loopDetected(508),
|
||||||
|
notExtended(510),
|
||||||
|
networkAuthenticationRequired(511),
|
||||||
|
// Client generated status code.
|
||||||
|
networkConnectTimeoutError(599);
|
||||||
|
|
||||||
|
final int statusCode;
|
||||||
|
|
||||||
|
const HttpStatus(this.statusCode);
|
||||||
|
|
||||||
|
bool equals(Object other) {
|
||||||
|
if (other is HttpStatus) {
|
||||||
|
return statusCode == other.statusCode;
|
||||||
|
}
|
||||||
|
if (other is int) {
|
||||||
|
return statusCode == other;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool isInfo() {
|
||||||
|
return statusCode >= 100 && statusCode < 200;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool isSuccess() {
|
||||||
|
return statusCode >= 200 && statusCode < 300;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool isRedirection() {
|
||||||
|
return statusCode >= 300 && statusCode < 400;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool isClientError() {
|
||||||
|
return statusCode >= 400 && statusCode < 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool isServerError() {
|
||||||
|
return statusCode >= 500 && statusCode < 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
factory HttpStatus.from(int status) {
|
||||||
|
return HttpStatus.values
|
||||||
|
.firstWhere((element) => element.statusCode == status);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
enum Protocols {
|
||||||
|
http,
|
||||||
|
https;
|
||||||
|
|
||||||
|
String get scheme => '$name://';
|
||||||
|
}
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:http/http.dart';
|
||||||
|
|
||||||
|
abstract class RequestUtils {
|
||||||
|
static Request _copyNormalRequestWith(
|
||||||
|
Request original, {
|
||||||
|
String? method,
|
||||||
|
Uri? url,
|
||||||
|
Map<String, String>? headers,
|
||||||
|
int? maxRedirects,
|
||||||
|
bool? followRedirects,
|
||||||
|
bool? persistentConnection,
|
||||||
|
String? body,
|
||||||
|
}) {
|
||||||
|
final request = Request(method ?? original.method, url ?? original.url)
|
||||||
|
..followRedirects = followRedirects ?? original.followRedirects
|
||||||
|
..headers.addAll(headers ?? original.headers)
|
||||||
|
..maxRedirects = maxRedirects ?? original.maxRedirects
|
||||||
|
..persistentConnection =
|
||||||
|
persistentConnection ?? original.persistentConnection
|
||||||
|
..body = body ?? original.body;
|
||||||
|
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
static BaseRequest copyRequestWith(
|
||||||
|
BaseRequest original, {
|
||||||
|
String? method,
|
||||||
|
Uri? url,
|
||||||
|
Map<String, String>? headers,
|
||||||
|
int? maxRedirects,
|
||||||
|
bool? followRedirects,
|
||||||
|
bool? persistentConnection,
|
||||||
|
String? body,
|
||||||
|
}) {
|
||||||
|
if (original is Request) {
|
||||||
|
return _copyNormalRequestWith(
|
||||||
|
original,
|
||||||
|
method: method,
|
||||||
|
url: url,
|
||||||
|
headers: headers,
|
||||||
|
maxRedirects: maxRedirects,
|
||||||
|
followRedirects: followRedirects,
|
||||||
|
persistentConnection: persistentConnection,
|
||||||
|
body: body,
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
throw UnimplementedError(
|
||||||
|
'Cannot handle requests of type ${original.runtimeType}',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static Request _copyNormalRequest(Request original) {
|
||||||
|
final request = Request(original.method, original.url)
|
||||||
|
..followRedirects = original.followRedirects
|
||||||
|
..headers.addAll(original.headers)
|
||||||
|
..maxRedirects = original.maxRedirects
|
||||||
|
..persistentConnection = original.persistentConnection
|
||||||
|
..body = original.body;
|
||||||
|
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
static BaseRequest copyRequest(BaseRequest original) {
|
||||||
|
if (original is Request) {
|
||||||
|
return _copyNormalRequest(original);
|
||||||
|
} else {
|
||||||
|
throw UnimplementedError(
|
||||||
|
'Cannot handle requests of type ${original.runtimeType}',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
export 'authentication_methods.dart';
|
||||||
|
export 'digest_auth.dart';
|
||||||
|
export 'header_keys.dart';
|
||||||
|
export 'http_methods.dart';
|
||||||
|
export 'http_status.dart';
|
||||||
|
export 'protocols.dart';
|
||||||
|
export 'request_utils.dart';
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
library wyatt_http_client;
|
||||||
|
|
||||||
|
export 'src/middleware.dart';
|
||||||
|
export 'src/middleware_client.dart';
|
||||||
|
export 'src/middlewares/middlewares.dart';
|
||||||
|
export 'src/models/models.dart';
|
||||||
|
export 'src/pipeline.dart';
|
||||||
|
export 'src/utils/utils.dart';
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
name: wyatt_http_client
|
||||||
|
description: A Dart client for RESTful APIs with authentication.
|
||||||
|
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_http_client
|
||||||
|
version: 1.2.0
|
||||||
|
|
||||||
|
environment:
|
||||||
|
sdk: '>=2.17.0 <3.0.0'
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
crypto: ^3.0.2
|
||||||
|
http: ^0.13.4
|
||||||
|
|
||||||
|
dev_dependencies:
|
||||||
|
wyatt_analysis:
|
||||||
|
git:
|
||||||
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
|
ref: wyatt_analysis-v2.0.1
|
||||||
|
path: packages/wyatt_analysis
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
// TODO(hpcl): Add tests.
|
||||||
@@ -15,5 +15,5 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
|
|||||||
Reference in New Issue
Block a user