2019-07-10 09:50:10 +00:00
|
|
|
/*
|
|
|
|
Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
import Promise from 'bluebird';
|
2019-07-23 14:11:38 +00:00
|
|
|
import classNames from 'classnames';
|
2019-07-10 09:50:10 +00:00
|
|
|
|
|
|
|
import MatrixClientPeg from './MatrixClientPeg';
|
|
|
|
import sdk from './';
|
|
|
|
import Modal from './Modal';
|
|
|
|
|
|
|
|
export class TermsNotSignedError extends Error {}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class representing a service that may have terms & conditions that
|
2019-07-10 13:17:15 +00:00
|
|
|
* require agreement from the user before the user can use that service.
|
2019-07-10 09:50:10 +00:00
|
|
|
*/
|
|
|
|
export class Service {
|
|
|
|
/**
|
2019-07-10 11:08:26 +00:00
|
|
|
* @param {MatrixClient.SERVICE_TYPES} serviceType The type of service
|
2019-07-10 09:50:10 +00:00
|
|
|
* @param {string} baseUrl The Base URL of the service (ie. before '/_matrix')
|
|
|
|
* @param {string} accessToken The user's access token for the service
|
|
|
|
*/
|
|
|
|
constructor(serviceType, baseUrl, accessToken) {
|
|
|
|
this.serviceType = serviceType;
|
|
|
|
this.baseUrl = baseUrl;
|
|
|
|
this.accessToken = accessToken;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-07-10 15:07:31 +00:00
|
|
|
/**
|
2019-07-10 13:22:50 +00:00
|
|
|
* Start a flow where the user is presented with terms & conditions for some services
|
|
|
|
*
|
2019-07-11 09:53:45 +00:00
|
|
|
* @param {Service[]} services Object with keys 'serviceType', 'baseUrl', 'accessToken'
|
|
|
|
* @param {function} interactionCallback Function called with:
|
2019-07-22 11:23:28 +00:00
|
|
|
* * an array of { service: {Service}, policies: {terms response from API} }
|
2019-07-11 09:53:45 +00:00
|
|
|
* * an array of URLs the user has already agreed to
|
2019-07-10 13:22:50 +00:00
|
|
|
* Must return a Promise which resolves with a list of URLs of documents agreed to
|
|
|
|
* @returns {Promise} resolves when the user agreed to all necessary terms or rejects
|
|
|
|
* if they cancel.
|
|
|
|
*/
|
2019-07-23 14:11:38 +00:00
|
|
|
export async function startTermsFlow(
|
|
|
|
services,
|
|
|
|
interactionCallback = dialogTermsInteractionCallback,
|
|
|
|
) {
|
2019-07-10 09:50:10 +00:00
|
|
|
const termsPromises = services.map(
|
2019-07-11 15:28:24 +00:00
|
|
|
(s) => MatrixClientPeg.get().getTerms(s.serviceType, s.baseUrl),
|
2019-07-10 09:50:10 +00:00
|
|
|
);
|
|
|
|
|
2019-07-10 13:25:30 +00:00
|
|
|
/*
|
|
|
|
* a /terms response looks like:
|
|
|
|
* {
|
|
|
|
* "policies": {
|
|
|
|
* "terms_of_service": {
|
|
|
|
* "version": "2.0",
|
|
|
|
* "en": {
|
|
|
|
* "name": "Terms of Service",
|
|
|
|
* "url": "https://example.org/somewhere/terms-2.0-en.html"
|
|
|
|
* },
|
|
|
|
* "fr": {
|
|
|
|
* "name": "Conditions d'utilisation",
|
|
|
|
* "url": "https://example.org/somewhere/terms-2.0-fr.html"
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
*/
|
|
|
|
|
2019-07-10 09:50:10 +00:00
|
|
|
const terms = await Promise.all(termsPromises);
|
2019-07-10 13:27:29 +00:00
|
|
|
const policiesAndServicePairs = terms.map((t, i) => { return { 'service': services[i], 'policies': t.policies }; });
|
2019-07-10 09:50:10 +00:00
|
|
|
|
2019-07-11 09:53:45 +00:00
|
|
|
// fetch the set of agreed policy URLs from account data
|
|
|
|
const currentAcceptedTerms = await MatrixClientPeg.get().getAccountData('m.accepted_terms');
|
|
|
|
let agreedUrlSet;
|
|
|
|
if (!currentAcceptedTerms || !currentAcceptedTerms.getContent() || !currentAcceptedTerms.getContent().accepted) {
|
|
|
|
agreedUrlSet = new Set();
|
|
|
|
} else {
|
|
|
|
agreedUrlSet = new Set(currentAcceptedTerms.getContent().accepted);
|
|
|
|
}
|
|
|
|
|
|
|
|
// remove any policies the user has already agreed to and any services where
|
|
|
|
// they've already agreed to all the policies
|
|
|
|
// NB. it could be nicer to show the user stuff they've already agreed to,
|
|
|
|
// but then they'd assume they can un-check the boxes to un-agree to a policy,
|
|
|
|
// but that is not a thing the API supports, so probably best to just show
|
|
|
|
// things they've not agreed to yet.
|
|
|
|
const unagreedPoliciesAndServicePairs = [];
|
|
|
|
for (const {service, policies} of policiesAndServicePairs) {
|
|
|
|
const unagreedPolicies = {};
|
|
|
|
for (const [policyName, policy] of Object.entries(policies)) {
|
|
|
|
let policyAgreed = false;
|
|
|
|
for (const lang of Object.keys(policy)) {
|
|
|
|
if (lang === 'version') continue;
|
|
|
|
if (agreedUrlSet.has(policy[lang].url)) {
|
|
|
|
policyAgreed = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (!policyAgreed) unagreedPolicies[policyName] = policy;
|
|
|
|
}
|
|
|
|
if (Object.keys(unagreedPolicies).length > 0) {
|
|
|
|
unagreedPoliciesAndServicePairs.push({service, policies: unagreedPolicies});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// if there's anything left to agree to, prompt the user
|
|
|
|
if (unagreedPoliciesAndServicePairs.length > 0) {
|
2019-07-22 11:23:55 +00:00
|
|
|
const newlyAgreedUrls = await interactionCallback(unagreedPoliciesAndServicePairs, [...agreedUrlSet]);
|
2019-07-11 09:53:45 +00:00
|
|
|
console.log("User has agreed to URLs", newlyAgreedUrls);
|
2019-09-05 12:38:32 +00:00
|
|
|
// Merge with previously agreed URLs
|
|
|
|
newlyAgreedUrls.forEach(url => agreedUrlSet.add(url));
|
2019-07-11 09:53:45 +00:00
|
|
|
} else {
|
|
|
|
console.log("User has already agreed to all required policies");
|
|
|
|
}
|
|
|
|
|
|
|
|
const newAcceptedTerms = { accepted: Array.from(agreedUrlSet) };
|
|
|
|
await MatrixClientPeg.get().setAccountData('m.accepted_terms', newAcceptedTerms);
|
2019-07-10 09:50:10 +00:00
|
|
|
|
2019-07-10 14:12:05 +00:00
|
|
|
const agreePromises = policiesAndServicePairs.map((policiesAndService) => {
|
2019-07-10 09:50:10 +00:00
|
|
|
// filter the agreed URL list for ones that are actually for this service
|
|
|
|
// (one URL may be used for multiple services)
|
|
|
|
// Not a particularly efficient loop but probably fine given the numbers involved
|
2019-07-11 09:53:45 +00:00
|
|
|
const urlsForService = Array.from(agreedUrlSet).filter((url) => {
|
2019-07-10 14:12:05 +00:00
|
|
|
for (const policy of Object.values(policiesAndService.policies)) {
|
|
|
|
for (const lang of Object.keys(policy)) {
|
2019-07-10 09:50:10 +00:00
|
|
|
if (lang === 'version') continue;
|
2019-07-10 14:12:05 +00:00
|
|
|
if (policy[lang].url === url) return true;
|
2019-07-10 09:50:10 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
});
|
|
|
|
|
|
|
|
if (urlsForService.length === 0) return Promise.resolve();
|
|
|
|
|
|
|
|
return MatrixClientPeg.get().agreeToTerms(
|
2019-07-10 14:12:05 +00:00
|
|
|
policiesAndService.service.serviceType,
|
|
|
|
policiesAndService.service.baseUrl,
|
|
|
|
policiesAndService.service.accessToken,
|
2019-07-10 09:50:10 +00:00
|
|
|
urlsForService,
|
|
|
|
);
|
|
|
|
});
|
|
|
|
return Promise.all(agreePromises);
|
|
|
|
}
|
|
|
|
|
2019-07-23 14:11:38 +00:00
|
|
|
export function dialogTermsInteractionCallback(
|
|
|
|
policiesAndServicePairs,
|
|
|
|
agreedUrls,
|
|
|
|
extraClassNames,
|
|
|
|
) {
|
2019-07-10 09:50:10 +00:00
|
|
|
return new Promise((resolve, reject) => {
|
2019-07-10 14:12:05 +00:00
|
|
|
console.log("Terms that need agreement", policiesAndServicePairs);
|
2019-07-10 09:50:10 +00:00
|
|
|
const TermsDialog = sdk.getComponent("views.dialogs.TermsDialog");
|
|
|
|
|
|
|
|
Modal.createTrackedDialog('Terms of Service', '', TermsDialog, {
|
2019-07-10 14:12:05 +00:00
|
|
|
policiesAndServicePairs,
|
2019-07-11 09:53:45 +00:00
|
|
|
agreedUrls,
|
2019-07-10 09:50:10 +00:00
|
|
|
onFinished: (done, agreedUrls) => {
|
|
|
|
if (!done) {
|
|
|
|
reject(new TermsNotSignedError());
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
resolve(agreedUrls);
|
|
|
|
},
|
2019-07-23 14:11:38 +00:00
|
|
|
}, classNames("mx_TermsDialog", extraClassNames));
|
2019-07-10 09:50:10 +00:00
|
|
|
});
|
|
|
|
}
|