forked from CringeStudios/element-desktop
Compare commits
No commits in common. "develop" and "release-v1.7.23" have entirely different histories.
develop
...
release-v1
@ -1,88 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
plugins: ["matrix-org", "n"],
|
|
||||||
extends: ["plugin:matrix-org/javascript"],
|
|
||||||
parserOptions: {
|
|
||||||
ecmaVersion: 2021,
|
|
||||||
project: ["tsconfig.json"],
|
|
||||||
},
|
|
||||||
env: {
|
|
||||||
es6: true,
|
|
||||||
node: true,
|
|
||||||
// we also have some browser code (ie. the preload script)
|
|
||||||
browser: true,
|
|
||||||
},
|
|
||||||
// NOTE: These rules are frozen and new rules should not be added here.
|
|
||||||
// New changes belong in https://github.com/matrix-org/eslint-plugin-matrix-org/
|
|
||||||
rules: {
|
|
||||||
"quotes": "off",
|
|
||||||
"indent": "off",
|
|
||||||
"prefer-promise-reject-errors": "off",
|
|
||||||
"no-async-promise-executor": "off",
|
|
||||||
|
|
||||||
"n/file-extension-in-import": ["error", "always"],
|
|
||||||
"unicorn/prefer-node-protocol": ["error"],
|
|
||||||
},
|
|
||||||
overrides: [
|
|
||||||
{
|
|
||||||
files: ["src/**/*.ts"],
|
|
||||||
extends: ["plugin:matrix-org/typescript"],
|
|
||||||
rules: {
|
|
||||||
// Things we do that break the ideal style
|
|
||||||
"prefer-promise-reject-errors": "off",
|
|
||||||
"quotes": "off",
|
|
||||||
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
// We're okay with assertion errors when we ask for them
|
|
||||||
"@typescript-eslint/no-non-null-assertion": "off",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
files: ["hak/**/*.ts"],
|
|
||||||
extends: ["plugin:matrix-org/typescript"],
|
|
||||||
parserOptions: {
|
|
||||||
project: ["hak/tsconfig.json"],
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// Things we do that break the ideal style
|
|
||||||
"prefer-promise-reject-errors": "off",
|
|
||||||
"quotes": "off",
|
|
||||||
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
// We're okay with assertion errors when we ask for them
|
|
||||||
"@typescript-eslint/no-non-null-assertion": "off",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
files: ["scripts/**/*.ts"],
|
|
||||||
extends: ["plugin:matrix-org/typescript"],
|
|
||||||
parserOptions: {
|
|
||||||
project: ["scripts/tsconfig.json"],
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// Things we do that break the ideal style
|
|
||||||
"prefer-promise-reject-errors": "off",
|
|
||||||
"quotes": "off",
|
|
||||||
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
// We're okay with assertion errors when we ask for them
|
|
||||||
"@typescript-eslint/no-non-null-assertion": "off",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
files: ["playwright/**/*.ts"],
|
|
||||||
extends: ["plugin:matrix-org/typescript"],
|
|
||||||
parserOptions: {
|
|
||||||
project: ["playwright/tsconfig.json"],
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// Things we do that break the ideal style
|
|
||||||
"prefer-promise-reject-errors": "off",
|
|
||||||
"quotes": "off",
|
|
||||||
|
|
||||||
"@typescript-eslint/no-explicit-any": "off",
|
|
||||||
// We're okay with assertion errors when we ask for them
|
|
||||||
"@typescript-eslint/no-non-null-assertion": "off",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
22
.eslintrc.js
Normal file
22
.eslintrc.js
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
module.exports = {
|
||||||
|
parserOptions: {
|
||||||
|
ecmaVersion: 8,
|
||||||
|
},
|
||||||
|
env: {
|
||||||
|
es6: true,
|
||||||
|
node: true,
|
||||||
|
// we also have some browser code (ie. the preload script)
|
||||||
|
browser: true,
|
||||||
|
},
|
||||||
|
extends: ["matrix-org"],
|
||||||
|
rules: {
|
||||||
|
// js-sdk uses a babel rule which we can't use because we
|
||||||
|
// don't use babel, so remove it & put the original back
|
||||||
|
"babel/no-invalid-this": "off",
|
||||||
|
"no-invalid-this": "error",
|
||||||
|
"quotes": "off",
|
||||||
|
"indent": "off",
|
||||||
|
"prefer-promise-reject-errors": "off",
|
||||||
|
"no-async-promise-executor": "off",
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,23 +0,0 @@
|
|||||||
on: [push, workflow_dispatch]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-element:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Download Cringe Studios configuration
|
|
||||||
run: "mkdir cringe && wget -O cringe/config.json https://chat.cringe-studios.com/config.json"
|
|
||||||
|
|
||||||
- name: Docker setup
|
|
||||||
run: "docker build --platform linux/amd64 -t element-desktop-dockerbuild -f dockerbuild/Dockerfile ."
|
|
||||||
|
|
||||||
- name: Docker build
|
|
||||||
run: >
|
|
||||||
ls -la && PWD=$(pwd) scripts/in-docker.sh bash -c 'ls -la &&
|
|
||||||
yarn add matrix-seshat &&
|
|
||||||
yarn &&
|
|
||||||
yarn run fetch --noverify --cfgdir cringe &&
|
|
||||||
SQLCIPHER_BUNDLED=1 yarn run docker:build:native &&
|
|
||||||
yarn run docker:build --linux rpm --linux deb --linux tar.xz --linux AppImage --win squirrel'
|
|
||||||
5
.github/CODEOWNERS
vendored
5
.github/CODEOWNERS
vendored
@ -1,5 +0,0 @@
|
|||||||
* @element-hq/element-web-reviewers
|
|
||||||
/.github/workflows/** @element-hq/element-web-team
|
|
||||||
/package.json @element-hq/element-web-team
|
|
||||||
/yarn.lock @element-hq/element-web-team
|
|
||||||
/src/i18n/strings
|
|
||||||
76
.github/ISSUE_TEMPLATE/bug-desktop.yml
vendored
76
.github/ISSUE_TEMPLATE/bug-desktop.yml
vendored
@ -1,76 +0,0 @@
|
|||||||
name: Bug report for the Element desktop app (not in a browser)
|
|
||||||
description: File a bug report if you are using the desktop Element application.
|
|
||||||
labels: [T-Defect]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report!
|
|
||||||
|
|
||||||
Please report security issues by email to security@matrix.org
|
|
||||||
- type: textarea
|
|
||||||
id: reproduction-steps
|
|
||||||
attributes:
|
|
||||||
label: Steps to reproduce
|
|
||||||
description: Please attach screenshots, videos or logs if you can.
|
|
||||||
placeholder: Tell us what you see!
|
|
||||||
value: |
|
|
||||||
1. Where are you starting? What can you see?
|
|
||||||
2. What do you click?
|
|
||||||
3. More steps…
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: result
|
|
||||||
attributes:
|
|
||||||
label: Outcome
|
|
||||||
placeholder: Tell us what went wrong
|
|
||||||
value: |
|
|
||||||
#### What did you expect?
|
|
||||||
|
|
||||||
#### What happened instead?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: input
|
|
||||||
id: os
|
|
||||||
attributes:
|
|
||||||
label: Operating system
|
|
||||||
placeholder: Windows, macOS, Ubuntu, Arch Linux…
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: Application version
|
|
||||||
description: You can find the version information in Settings -> Help & About.
|
|
||||||
placeholder: e.g. Element version 1.7.34, olm version 3.2.3
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
|
||||||
id: source
|
|
||||||
attributes:
|
|
||||||
label: How did you install the app?
|
|
||||||
description: Where did you install the app from? Please give a link or a description.
|
|
||||||
placeholder: e.g. From https://element.io/get-started
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
|
||||||
id: homeserver
|
|
||||||
attributes:
|
|
||||||
label: Homeserver
|
|
||||||
description: |
|
|
||||||
Which server is your account registered on? If it is a local or non-public homeserver, please tell us what is the homeserver implementation (ex: Synapse/Dendrite/etc.) and the version.
|
|
||||||
placeholder: e.g. matrix.org or Synapse 1.50.0rc1
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: dropdown
|
|
||||||
id: rageshake
|
|
||||||
attributes:
|
|
||||||
label: Will you send logs?
|
|
||||||
description: |
|
|
||||||
Did you know that you can send a /rageshake command from your application to submit logs for this issue? Trigger the defect, then type `/rageshake` into the message input area followed by a description of the problem and send the command. You will be able to add a link to this defect report and submit anonymous logs to the developers.
|
|
||||||
options:
|
|
||||||
- "Yes"
|
|
||||||
- "No"
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
5
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,5 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: Bug report for the Element flatpak app
|
|
||||||
url: https://github.com/flathub/im.riot.Riot/issues
|
|
||||||
about: Please file bugs with the Flatpak application on the respective repository.
|
|
||||||
36
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
36
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
@ -1,36 +0,0 @@
|
|||||||
name: Enhancement request
|
|
||||||
description: Do you have a suggestion or feature request?
|
|
||||||
labels: [T-Enhancement]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thank you for taking the time to propose an enhancement to an existing feature. If you would like to propose a new feature or a major cross-platform change, please [start a discussion here](https://github.com/vector-im/element-meta/discussions/new?category=ideas).
|
|
||||||
- type: textarea
|
|
||||||
id: usecase
|
|
||||||
attributes:
|
|
||||||
label: Your use case
|
|
||||||
description: What would you like to be able to do? Please feel welcome to include screenshots or mock ups.
|
|
||||||
placeholder: Tell us what you would like to do!
|
|
||||||
value: |
|
|
||||||
#### What would you like to do?
|
|
||||||
|
|
||||||
#### Why would you like to do it?
|
|
||||||
|
|
||||||
#### How would you like to achieve it?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: alternative
|
|
||||||
attributes:
|
|
||||||
label: Have you considered any alternatives?
|
|
||||||
placeholder: A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: additional-context
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
placeholder: Is there anything else you'd like to add?
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,8 +0,0 @@
|
|||||||
<!-- Thanks for submitting a PR! Please ensure the following requirements are met in order for us to review your PR -->
|
|
||||||
|
|
||||||
## Checklist
|
|
||||||
|
|
||||||
- [ ] Ensure your code works with manual testing.
|
|
||||||
- [ ] New or updated `public`/`exported` symbols have accurate [TSDoc](https://tsdoc.org/) documentation.
|
|
||||||
- [ ] Linter and other CI checks pass.
|
|
||||||
- [ ] I have licensed the changes to Element by completing the [Contributor License Agreement (CLA)](https://cla-assistant.io/element-hq/element-desktop)
|
|
||||||
35
.github/SSLcom-sandbox.crt
vendored
35
.github/SSLcom-sandbox.crt
vendored
@ -1,35 +0,0 @@
|
|||||||
-----BEGIN CERTIFICATE-----
|
|
||||||
MIIGBzCCA++gAwIBAgIIaI6ivggL++4wDQYJKoZIhvcNAQELBQAwgZAxCzAJBgNV
|
|
||||||
BAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4GA1UEBwwHSG91c3RvbjEYMBYGA1UE
|
|
||||||
CgwPU1NMIENvcnBvcmF0aW9uMUUwQwYDVQQDDDxTU0wuY29tIEVWIFJvb3QgQ2Vy
|
|
||||||
dGlmaWNhdGlvbiBBdXRob3JpdHkgUlNBIFIyIC0gRGV2ZWxvcG1lbnQwHhcNMTgw
|
|
||||||
MTE2MTIxNjM2WhcNNDMwMTE1MTIxNjM2WjCBkDELMAkGA1UEBhMCVVMxDjAMBgNV
|
|
||||||
BAgMBVRleGFzMRAwDgYDVQQHDAdIb3VzdG9uMRgwFgYDVQQKDA9TU0wgQ29ycG9y
|
|
||||||
YXRpb24xRTBDBgNVBAMMPFNTTC5jb20gRVYgUm9vdCBDZXJ0aWZpY2F0aW9uIEF1
|
|
||||||
dGhvcml0eSBSU0EgUjIgLSBEZXZlbG9wbWVudDCCAiIwDQYJKoZIhvcNAQEBBQAD
|
|
||||||
ggIPADCCAgoCggIBAK/qcD65JCkueKp0+KXG2kAw8euDHuraLR3lJoUFz4ilGK1M
|
|
||||||
t+RjSuY6dHQw8ku7TnW9ejWoSFjCBSDx7tP/fzOwOxmBW6+F1NDuV/IaUtn3G2lk
|
|
||||||
CZglVk9z3n1HuWDN10xNiLoo5nzeIlvNAoDbXDGhI4Y6Z0qouAIS607JpJMWHOqZ
|
|
||||||
OUiiOuM11gI5Kz9GtVttXCjRmwlkU8WiJVIUuVedQAQt2FChrzNQewGFFi0uIau/
|
|
||||||
wFRclx6hd4JRIImC6VMJd9lcitWsqMcM94pD3fX2ozNgWX+MVlmcDYFSN9Sv8tG4
|
|
||||||
yCj4ONS8HZGzbxeyQXJhEJSi2FnBi0j6MD/d4DNFj0hCg9wz3fgVLDGCO0pNMO0Y
|
|
||||||
oXdrzfoj1/zEv0Ibgh7zKG2JHkPfapn3ExFI5d6xi66u5tPVI8cvLxqrgybRPs7Z
|
|
||||||
y1dQA7ew3LyTPAHoGtbTMvewtx1TkTtRxxhRRm0l58owqSVbSYrixFtosNobCERo
|
|
||||||
uiknaQqoY1ZDsdKsaqFoZDbntNRYhN3Ea4OPWVqDUU5ZPz9MTIRAi3MIq854yyQo
|
|
||||||
BjX9nv+kYa+Esr19pxUW0z7BWFhbXsMVpt0QMVyhwgzXvEreaZHFwHHaGb9d5x5P
|
|
||||||
VBDhsigMmtzBk9NlbCsy+uGXWHgZA/DVefueEq0sv38VoU30uYa5Tj0FLm09AgMB
|
|
||||||
AAGjYzBhMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUI9PCucv3G9fRoTDu
|
|
||||||
ZQ4Hw6g4PkIwHQYDVR0OBBYEFCPTwrnL9xvX0aEw7mUOB8OoOD5CMA4GA1UdDwEB
|
|
||||||
/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAk43CCrC0Zbvi7YUsSePKi+KzvyQ9
|
|
||||||
mjKa5NBU/A5/sLeZS3R+wqCX7l5euYVDsUuNgNVD/QL9jNIonuHBrvKaxkmqxE1r
|
|
||||||
IcDEaUdjy2lQ0uqD7UDoS3ctrjGkPpUahrTdr3gaKcQBtUhn9v4Y2OBm6J1hDVwI
|
|
||||||
CIKcxIzRv6AUpApOtk+++m5tzDU48t8+GzrVl1hkspSYcumA+zuHllbPDL1ADdo5
|
|
||||||
kK/bBQtZrGqzPqKzeqaB1A5Wm0Igwf++7nyzdKNdjxtv907D9vg8EB4Swavuv/Ne
|
|
||||||
5/jbpI32pz0NIzzSl5ARAHuFhILsO/cEAlloDoTHzibHqFDIeU9/59HMUsJYMOtD
|
|
||||||
Ii0/LmQ6dBE4TeukCCLJwtkFYZ2eBgDjF/LHBB+z/UBs4milRgwx+Pe5UDUEjtGe
|
|
||||||
G/XMVnTSKZTy9jMaXJD5EmfP+Cfh8EEgFgjg4AmLUbEo9gXzPxyXSLgd8JGSsjg8
|
|
||||||
EV/Ri4Mmmt4XUwlSVvEOezxxDGd17gwbottCIC+rqPHonHkGmKpLMH80Bk0uOOCs
|
|
||||||
ui1oVwSifMyIcudgCcOfRLUf/f2j2NW7N7E7Vw/Zqfn+pqp/EG0KCqOM2vfJAc0s
|
|
||||||
u3rSrOJZGtB6txgtmTjoadxApWf4U/FCi3uArt6gS5MJqZjuiRNXs/K3SlSAqLGl
|
|
||||||
5UiG52ew+VdBHzE=
|
|
||||||
-----END CERTIFICATE-----
|
|
||||||
31
.github/labels.yml
vendored
31
.github/labels.yml
vendored
@ -1,31 +0,0 @@
|
|||||||
- name: "A-Install"
|
|
||||||
color: "72A447"
|
|
||||||
- name: "A-Seshat"
|
|
||||||
color: "8262BE"
|
|
||||||
- name: "A-Update"
|
|
||||||
color: "17BE67"
|
|
||||||
- name: "Story"
|
|
||||||
description: "A change to the product that generates user value on its own. Unit of delivery."
|
|
||||||
color: "0BAC47"
|
|
||||||
- name: "X-Breaking-Change"
|
|
||||||
color: "ff7979"
|
|
||||||
- name: "Z-Arch"
|
|
||||||
color: "D601BE"
|
|
||||||
- name: "Z-ARM"
|
|
||||||
color: "5DEC5B"
|
|
||||||
- name: "Z-Flatpak"
|
|
||||||
color: "0CA856"
|
|
||||||
- name: "Z-Linux"
|
|
||||||
color: "7B4A9C"
|
|
||||||
- name: "Z-macOS"
|
|
||||||
color: "500605"
|
|
||||||
- name: "Z-Official"
|
|
||||||
color: "1D2B20"
|
|
||||||
- name: "Z-Snap"
|
|
||||||
color: "29CD95"
|
|
||||||
- name: "Z-Suse"
|
|
||||||
color: "79D07B"
|
|
||||||
- name: "Z-Wayland"
|
|
||||||
color: "94C519"
|
|
||||||
- name: "Z-Windows"
|
|
||||||
color: "0632DE"
|
|
||||||
1
.github/release-drafter.yml
vendored
1
.github/release-drafter.yml
vendored
@ -1 +0,0 @@
|
|||||||
_extends: element-hq/element-web
|
|
||||||
4
.github/renovate.json
vendored
4
.github/renovate.json
vendored
@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
|
||||||
"extends": ["github>matrix-org/renovate-config-element-web"]
|
|
||||||
}
|
|
||||||
32
.github/workflows/backport.yml
vendored
32
.github/workflows/backport.yml
vendored
@ -1,32 +0,0 @@
|
|||||||
name: Backport
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
types:
|
|
||||||
- closed
|
|
||||||
- labeled
|
|
||||||
branches:
|
|
||||||
- develop
|
|
||||||
|
|
||||||
permissions: {} # We use ELEMENT_BOT_TOKEN instead
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
backport:
|
|
||||||
name: Backport
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
# Only react to merged PRs for security reasons.
|
|
||||||
# See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
|
|
||||||
if: >
|
|
||||||
github.event.pull_request.merged
|
|
||||||
&& (
|
|
||||||
github.event.action == 'closed'
|
|
||||||
|| (
|
|
||||||
github.event.action == 'labeled'
|
|
||||||
&& contains(github.event.label.name, 'backport')
|
|
||||||
)
|
|
||||||
)
|
|
||||||
steps:
|
|
||||||
- uses: tibdex/backport@9565281eda0731b1d20c4025c43339fb0a23812e # v2
|
|
||||||
with:
|
|
||||||
labels_template: "<%= JSON.stringify([...labels, 'X-Release-Blocker']) %>"
|
|
||||||
# We can't use GITHUB_TOKEN here or CI won't run on the new PR
|
|
||||||
github_token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
305
.github/workflows/build_and_deploy.yaml
vendored
305
.github/workflows/build_and_deploy.yaml
vendored
@ -1,305 +0,0 @@
|
|||||||
name: Build and Deploy
|
|
||||||
on:
|
|
||||||
# Nightly build
|
|
||||||
schedule:
|
|
||||||
- cron: "0 9 * * *"
|
|
||||||
# Release build
|
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
# Manual nightly & release
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
mode:
|
|
||||||
description: What type of build to trigger. Release builds MUST be ran from the `master` branch.
|
|
||||||
required: true
|
|
||||||
default: nightly
|
|
||||||
type: choice
|
|
||||||
options:
|
|
||||||
- nightly
|
|
||||||
- release
|
|
||||||
macos:
|
|
||||||
description: Build macOS
|
|
||||||
required: true
|
|
||||||
type: boolean
|
|
||||||
default: true
|
|
||||||
windows:
|
|
||||||
description: Build Windows
|
|
||||||
required: true
|
|
||||||
type: boolean
|
|
||||||
default: true
|
|
||||||
linux:
|
|
||||||
description: Build Linux
|
|
||||||
required: true
|
|
||||||
type: boolean
|
|
||||||
default: true
|
|
||||||
deploy:
|
|
||||||
description: Deploy artifacts
|
|
||||||
required: true
|
|
||||||
type: boolean
|
|
||||||
default: true
|
|
||||||
run-name: Element ${{ inputs.mode != 'release' && github.event_name != 'release' && 'Nightly' || 'Desktop' }}
|
|
||||||
concurrency: ${{ github.workflow }}
|
|
||||||
env:
|
|
||||||
R2_BUCKET: ${{ vars.R2_BUCKET }}
|
|
||||||
permissions: {} # Uses ELEMENT_BOT_TOKEN
|
|
||||||
jobs:
|
|
||||||
prepare:
|
|
||||||
uses: ./.github/workflows/build_prepare.yaml
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
with:
|
|
||||||
config: element.io/${{ inputs.mode || (github.event_name == 'release' && 'release') || 'nightly' }}
|
|
||||||
version: ${{ (inputs.mode != 'release' && github.event_name != 'release') && 'develop' || '' }}
|
|
||||||
nightly: ${{ inputs.mode != 'release' && github.event_name != 'release' }}
|
|
||||||
deploy: ${{ inputs.deploy || (github.event_name != 'workflow_dispatch' && github.event.release.prerelease != true) }}
|
|
||||||
secrets:
|
|
||||||
CF_R2_ACCESS_KEY_ID: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
|
|
||||||
CF_R2_TOKEN: ${{ secrets.CF_R2_TOKEN }}
|
|
||||||
|
|
||||||
windows:
|
|
||||||
if: github.event_name != 'workflow_dispatch' || inputs.windows
|
|
||||||
needs: prepare
|
|
||||||
name: Windows ${{ matrix.arch }}
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
arch: [ia32, x64, arm64]
|
|
||||||
uses: ./.github/workflows/build_windows.yaml
|
|
||||||
secrets: inherit
|
|
||||||
with:
|
|
||||||
sign: true
|
|
||||||
arch: ${{ matrix.arch }}
|
|
||||||
version: ${{ needs.prepare.outputs.nightly-version }}
|
|
||||||
|
|
||||||
macos:
|
|
||||||
if: github.event_name != 'workflow_dispatch' || inputs.macos
|
|
||||||
needs: prepare
|
|
||||||
name: macOS
|
|
||||||
uses: ./.github/workflows/build_macos.yaml
|
|
||||||
secrets: inherit
|
|
||||||
with:
|
|
||||||
sign: true
|
|
||||||
base-url: https://packages.element.io/${{ needs.prepare.outputs.packages-dir }}
|
|
||||||
version: ${{ needs.prepare.outputs.nightly-version }}
|
|
||||||
|
|
||||||
linux:
|
|
||||||
if: github.event_name != 'workflow_dispatch' || inputs.linux
|
|
||||||
needs: prepare
|
|
||||||
name: Linux ${{ matrix.arch }} (sqlcipher ${{ matrix.sqlcipher }})
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
arch: [amd64, arm64]
|
|
||||||
sqlcipher: [static]
|
|
||||||
uses: ./.github/workflows/build_linux.yaml
|
|
||||||
with:
|
|
||||||
arch: ${{ matrix.arch }}
|
|
||||||
sqlcipher: ${{ matrix.sqlcipher }}
|
|
||||||
version: ${{ needs.prepare.outputs.nightly-version }}
|
|
||||||
|
|
||||||
deploy:
|
|
||||||
needs:
|
|
||||||
- prepare
|
|
||||||
- macos
|
|
||||||
- linux
|
|
||||||
- windows
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
name: ${{ needs.prepare.outputs.deploy == 'true' && 'Deploy' || 'Deploy (dry-run)' }}
|
|
||||||
if: always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled')
|
|
||||||
environment: ${{ needs.prepare.outputs.deploy == 'true' && 'packages.element.io' || '' }}
|
|
||||||
steps:
|
|
||||||
- name: Download artifacts
|
|
||||||
uses: actions/download-artifact@v4
|
|
||||||
|
|
||||||
- name: Prepare artifacts for deployment
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
for arch in x64 ia32 arm64
|
|
||||||
do
|
|
||||||
if [ -d "win-$arch" ]; then
|
|
||||||
mkdir -p packages.element.io/{install,update}/win32/$arch
|
|
||||||
mv win-$arch/squirrel-windows*/*.exe "packages.element.io/install/win32/$arch/"
|
|
||||||
mv win-$arch/squirrel-windows*/*.nupkg "packages.element.io/update/win32/$arch/"
|
|
||||||
mv win-$arch/squirrel-windows*/RELEASES "packages.element.io/update/win32/$arch/"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
if [ -d macos ]; then
|
|
||||||
mkdir -p packages.element.io/{install,update}/macos
|
|
||||||
mv macos/*.dmg packages.element.io/install/macos/
|
|
||||||
mv macos/*-mac.zip packages.element.io/update/macos/
|
|
||||||
mv macos/*.json packages.element.io/update/macos/
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Linux
|
|
||||||
if [ -d linux-amd64-sqlcipher-static ]; then
|
|
||||||
mkdir -p packages.element.io/install/linux/glibc-x86-64
|
|
||||||
mv linux-amd64-sqlcipher-static/*.tar.gz packages.element.io/install/linux/glibc-x86-64
|
|
||||||
fi
|
|
||||||
if [ -d linux-arm64-sqlcipher-static ]; then
|
|
||||||
mkdir -p packages.element.io/install/linux/glibc-aarch64
|
|
||||||
mv linux-arm64-sqlcipher-static/*.tar.gz packages.element.io/install/linux/glibc-aarch64
|
|
||||||
fi
|
|
||||||
|
|
||||||
# We don't wish to store the installer for every nightly ever, so we only keep the latest
|
|
||||||
- name: "[Nightly] Strip version from installer file"
|
|
||||||
if: needs.prepare.outputs.nightly-version != ''
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
for arch in x64 ia32 arm64
|
|
||||||
do
|
|
||||||
[ -d "win-$arch" ] && mv packages.element.io/install/win32/$arch/{*,"Element Nightly Setup"}.exe
|
|
||||||
done
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
[ -d macos ] && mv packages.element.io/install/macos/{*,"Element Nightly"}.dmg
|
|
||||||
|
|
||||||
# Linux
|
|
||||||
[ -d linux-amd64-sqlcipher-static ] && mv packages.element.io/install/linux/glibc-x86-64/{*,element-desktop-nightly}.tar.gz
|
|
||||||
[ -d linux-arm64-sqlcipher-static ] && mv packages.element.io/install/linux/glibc-aarch64/{*,element-desktop-nightly}.tar.gz
|
|
||||||
|
|
||||||
- name: "[Release] Prepare release latest symlink"
|
|
||||||
if: needs.prepare.outputs.nightly-version == ''
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
for arch in x64 ia32 arm64
|
|
||||||
do
|
|
||||||
if [ -d "win-$arch" ]; then
|
|
||||||
pushd packages.element.io/install/win32/$arch
|
|
||||||
ln -s "$(find . -type f -iname "*.exe" | xargs -0 -n1 -- basename)" "Element Setup.exe"
|
|
||||||
popd
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
if [ -d macos ]; then
|
|
||||||
pushd packages.element.io/install/macos
|
|
||||||
ln -s "$(find . -type f -iname "*.dmg" | xargs -0 -n1 -- basename)" "Element.dmg"
|
|
||||||
popd
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Linux
|
|
||||||
if [ -d linux-amd64-sqlcipher-static ]; then
|
|
||||||
pushd packages.element.io/install/linux/glibc-x86-64
|
|
||||||
ln -s "$(find . -type f -iname "*.tar.gz" | xargs -0 -n1 -- basename)" "element-desktop.tar.gz"
|
|
||||||
popd
|
|
||||||
fi
|
|
||||||
if [ -d linux-arm64-sqlcipher-static ]; then
|
|
||||||
pushd packages.element.io/install/linux/glibc-aarch64
|
|
||||||
ln -s "$(find . -type f -iname "*.tar.gz" | xargs -0 -n1 -- basename)" "element-desktop.tar.gz"
|
|
||||||
popd
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Stash packages.element.io
|
|
||||||
if: needs.prepare.outputs.deploy == 'false'
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: packages.element.io
|
|
||||||
path: packages.element.io
|
|
||||||
|
|
||||||
# Workaround for https://www.cloudflarestatus.com/incidents/t5nrjmpxc1cj
|
|
||||||
- uses: unfor19/install-aws-cli-action@e8b481e524a99f37fbd39fdc1dcb3341ab091367 # v1
|
|
||||||
if: needs.prepare.outputs.deploy == 'true'
|
|
||||||
with:
|
|
||||||
version: 2.22.35
|
|
||||||
verbose: false
|
|
||||||
arch: amd64
|
|
||||||
|
|
||||||
- name: Deploy artifacts
|
|
||||||
if: needs.prepare.outputs.deploy == 'true'
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
aws s3 cp --recursive packages.element.io/ s3://$R2_BUCKET/$DEPLOYMENT_DIR --endpoint-url $R2_URL --region auto
|
|
||||||
env:
|
|
||||||
AWS_ACCESS_KEY_ID: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
|
|
||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_TOKEN }}
|
|
||||||
R2_URL: ${{ vars.CF_R2_S3_API }}
|
|
||||||
DEPLOYMENT_DIR: ${{ needs.prepare.outputs.packages-dir }}
|
|
||||||
|
|
||||||
- name: Notify packages.element.io of new files
|
|
||||||
if: needs.prepare.outputs.deploy == 'true'
|
|
||||||
uses: peter-evans/repository-dispatch@ff45666b9427631e3450c54a1bcbee4d9ff4d7c0 # v3
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
repository: element-hq/packages.element.io
|
|
||||||
event-type: packages-index
|
|
||||||
|
|
||||||
- name: Find debs
|
|
||||||
id: deb
|
|
||||||
if: needs.linux.result == 'success'
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
|
|
||||||
for arch in amd64 arm64
|
|
||||||
do
|
|
||||||
echo "$arch=$(ls linux-$arch-sqlcipher-static/*.deb | tail -n1)" >> $GITHUB_OUTPUT
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Stash debs
|
|
||||||
if: needs.prepare.outputs.deploy == 'false' && needs.linux.result == 'success'
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: debs
|
|
||||||
path: |
|
|
||||||
${{ steps.deb.outputs.amd64 }}
|
|
||||||
${{ steps.deb.outputs.arm64 }}
|
|
||||||
|
|
||||||
- name: Publish amd64 deb to packages.element.io
|
|
||||||
uses: element-hq/packages.element.io@master
|
|
||||||
if: needs.prepare.outputs.deploy == 'true' && needs.linux.result == 'success'
|
|
||||||
with:
|
|
||||||
file: ${{ steps.deb.outputs.amd64 }}
|
|
||||||
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
bucket-api: ${{ vars.CF_R2_S3_API }}
|
|
||||||
bucket-key-id: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
|
|
||||||
bucket-access-key: ${{ secrets.CF_R2_TOKEN }}
|
|
||||||
|
|
||||||
- name: Publish arm64 deb to packages.element.io
|
|
||||||
uses: element-hq/packages.element.io@master
|
|
||||||
if: needs.prepare.outputs.deploy == 'true' && needs.linux.result == 'success'
|
|
||||||
with:
|
|
||||||
file: ${{ steps.deb.outputs.arm64 }}
|
|
||||||
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
bucket-api: ${{ vars.CF_R2_S3_API }}
|
|
||||||
bucket-key-id: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
|
|
||||||
bucket-access-key: ${{ secrets.CF_R2_TOKEN }}
|
|
||||||
|
|
||||||
deploy-ess:
|
|
||||||
needs: deploy
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
name: Deploy builds to ESS
|
|
||||||
if: needs.prepare.outputs.deploy == 'true' && github.event_name == 'release'
|
|
||||||
env:
|
|
||||||
BUCKET_NAME: "element-desktop-msi.onprem.element.io"
|
|
||||||
AWS_REGION: "eu-central-1"
|
|
||||||
permissions:
|
|
||||||
id-token: write # This is required for requesting the JWT
|
|
||||||
steps:
|
|
||||||
- name: Configure AWS credentials
|
|
||||||
uses: aws-actions/configure-aws-credentials@v4
|
|
||||||
with:
|
|
||||||
role-to-assume: arn:aws:iam::264135176173:role/Push-ElementDesktop-MSI
|
|
||||||
role-session-name: githubaction-run-${{ github.run_id }}
|
|
||||||
aws-region: ${{ env.AWS_REGION }}
|
|
||||||
|
|
||||||
- name: Download artifacts
|
|
||||||
uses: actions/download-artifact@v4
|
|
||||||
with:
|
|
||||||
pattern: win-*
|
|
||||||
|
|
||||||
- name: Copy files to S3
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
|
|
||||||
PREFIX="${VERSION%.*}"
|
|
||||||
for file in win-*/*.msi; do
|
|
||||||
filename=$(basename "$file")
|
|
||||||
aws s3 cp "$file" "s3://${{ env.BUCKET_NAME }}/$PREFIX/$filename"
|
|
||||||
done
|
|
||||||
env:
|
|
||||||
VERSION: ${{ github.event.release.tag_name }}
|
|
||||||
137
.github/workflows/build_and_test.yaml
vendored
137
.github/workflows/build_and_test.yaml
vendored
@ -1,137 +0,0 @@
|
|||||||
name: Build and Test
|
|
||||||
on:
|
|
||||||
pull_request: {}
|
|
||||||
push:
|
|
||||||
branches: [develop, staging, master]
|
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
permissions: {} # No permissions required
|
|
||||||
jobs:
|
|
||||||
fetch:
|
|
||||||
uses: ./.github/workflows/build_prepare.yaml
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
with:
|
|
||||||
config: ${{ github.event.pull_request.base.ref == 'develop' && 'element.io/nightly' || 'element.io/release' }}
|
|
||||||
version: ${{ github.event.pull_request.base.ref == 'develop' && 'develop' || '' }}
|
|
||||||
|
|
||||||
windows:
|
|
||||||
needs: fetch
|
|
||||||
name: Windows
|
|
||||||
uses: ./.github/workflows/build_windows.yaml
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
arch: [x64, ia32, arm64]
|
|
||||||
with:
|
|
||||||
arch: ${{ matrix.arch }}
|
|
||||||
|
|
||||||
linux:
|
|
||||||
needs: fetch
|
|
||||||
name: "Linux (${{ matrix.arch }}) (sqlcipher: ${{ matrix.sqlcipher }})"
|
|
||||||
uses: ./.github/workflows/build_linux.yaml
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
sqlcipher: [system, static]
|
|
||||||
arch: [amd64, arm64]
|
|
||||||
with:
|
|
||||||
sqlcipher: ${{ matrix.sqlcipher }}
|
|
||||||
arch: ${{ matrix.arch }}
|
|
||||||
|
|
||||||
macos:
|
|
||||||
needs: fetch
|
|
||||||
name: macOS
|
|
||||||
uses: ./.github/workflows/build_macos.yaml
|
|
||||||
|
|
||||||
test:
|
|
||||||
needs:
|
|
||||||
- macos
|
|
||||||
- linux
|
|
||||||
- windows
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- name: macOS Universal
|
|
||||||
os: macos-14
|
|
||||||
artifact: macos
|
|
||||||
executable: "/Users/runner/Applications/Element.app/Contents/MacOS/Element"
|
|
||||||
# We need to mount the DMG and copy the app to the Applications folder as a mounted DMG is
|
|
||||||
# read-only and thus would not allow us to override the fuses as is required for Playwright.
|
|
||||||
prepare_cmd: |
|
|
||||||
hdiutil attach ./dist/*.dmg -mountpoint /Volumes/Element &&
|
|
||||||
rsync -a /Volumes/Element/Element.app ~/Applications/ &&
|
|
||||||
hdiutil detach /Volumes/Element
|
|
||||||
- name: "Linux (amd64) (sqlcipher: system)"
|
|
||||||
os: ubuntu-22.04
|
|
||||||
artifact: linux-amd64-sqlcipher-system
|
|
||||||
executable: "/opt/Element/element-desktop"
|
|
||||||
prepare_cmd: "sudo apt-get -qq update && sudo apt install ./dist/*.deb"
|
|
||||||
- name: "Linux (amd64) (sqlcipher: static)"
|
|
||||||
os: ubuntu-22.04
|
|
||||||
artifact: linux-amd64-sqlcipher-static
|
|
||||||
executable: "/opt/Element/element-desktop"
|
|
||||||
prepare_cmd: "sudo apt-get -qq update && sudo apt install ./dist/*.deb"
|
|
||||||
- name: "Linux (arm64) (sqlcipher: system)"
|
|
||||||
os: ubuntu-22.04-arm
|
|
||||||
artifact: linux-arm64-sqlcipher-system
|
|
||||||
executable: "/opt/Element/element-desktop"
|
|
||||||
prepare_cmd: "sudo apt-get -qq update && sudo apt install -y ./dist/*.deb"
|
|
||||||
- name: "Linux (arm64) (sqlcipher: static)"
|
|
||||||
os: ubuntu-22.04-arm
|
|
||||||
artifact: linux-arm64-sqlcipher-static
|
|
||||||
executable: "/opt/Element/element-desktop"
|
|
||||||
prepare_cmd: "sudo apt-get -qq update && sudo apt install -y ./dist/*.deb"
|
|
||||||
- name: Windows (x86)
|
|
||||||
os: windows-2022
|
|
||||||
artifact: win-ia32
|
|
||||||
executable: "./dist/win-ia32-unpacked/Element.exe"
|
|
||||||
- name: Windows (x64)
|
|
||||||
os: windows-2022
|
|
||||||
artifact: win-x64
|
|
||||||
executable: "./dist/win-unpacked/Element.exe"
|
|
||||||
name: Test ${{ matrix.name }}
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- uses: actions/download-artifact@v4
|
|
||||||
with:
|
|
||||||
name: ${{ matrix.artifact }}
|
|
||||||
path: dist
|
|
||||||
|
|
||||||
- name: Prepare for tests
|
|
||||||
run: ${{ matrix.prepare_cmd }}
|
|
||||||
if: matrix.prepare_cmd
|
|
||||||
|
|
||||||
# We previously disabled the `EnableNodeCliInspectArguments` fuse, but Playwright requires
|
|
||||||
# it to be enabled to test Electron apps, so turn it back on.
|
|
||||||
- name: Set EnableNodeCliInspectArguments fuse enabled
|
|
||||||
run: $RUN_AS npx @electron/fuses write --app ${{ matrix.executable }} EnableNodeCliInspectArguments=on
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
# We need sudo on Linux as it is installed in /opt/
|
|
||||||
RUN_AS: ${{ runner.os == 'Linux' && 'sudo' || '' }}
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
uses: coactions/setup-xvfb@6b00cf1889f4e1d5a48635647013c0508128ee1a
|
|
||||||
timeout-minutes: 5
|
|
||||||
with:
|
|
||||||
run: "yarn test ${{ runner.os != 'Linux' && '--ignore-snapshots' || '' }}"
|
|
||||||
env:
|
|
||||||
ELEMENT_DESKTOP_EXECUTABLE: ${{ matrix.executable }}
|
|
||||||
|
|
||||||
- name: Upload HTML report
|
|
||||||
if: always()
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: ${{ matrix.artifact }}-test
|
|
||||||
path: playwright/html-report
|
|
||||||
retention-days: 14
|
|
||||||
185
.github/workflows/build_linux.yaml
vendored
185
.github/workflows/build_linux.yaml
vendored
@ -1,185 +0,0 @@
|
|||||||
# This workflow relies on actions/cache to store the hak dependency artifacts as they take a long time to build
|
|
||||||
# Due to this extra care must be taken to only ever run all build_* scripts against the same branch to ensure
|
|
||||||
# the correct cache scoping, and additional care must be taken to not run untrusted actions on the develop branch.
|
|
||||||
on:
|
|
||||||
workflow_call:
|
|
||||||
inputs:
|
|
||||||
arch:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: "The architecture to build for, one of 'amd64' | 'arm64'"
|
|
||||||
version:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "Version string to override the one in package.json, used for non-release builds"
|
|
||||||
sqlcipher:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: "How to link sqlcipher, one of 'system' | 'static'"
|
|
||||||
env:
|
|
||||||
SQLCIPHER_BUNDLED: ${{ inputs.sqlcipher == 'static' && '1' || '' }}
|
|
||||||
MAX_GLIBC: 2.31 # bullseye-era glibc, used by glibc-check.sh
|
|
||||||
permissions: {} # No permissions required
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
# We build on native infrastructure as matrix-seshat fails to cross-compile properly
|
|
||||||
# https://github.com/matrix-org/seshat/issues/135
|
|
||||||
runs-on: ${{ inputs.arch == 'arm64' && 'ubuntu-22.04-arm' || 'ubuntu-22.04' }}
|
|
||||||
env:
|
|
||||||
HAK_DOCKER_IMAGE: ghcr.io/element-hq/element-desktop-dockerbuild
|
|
||||||
steps:
|
|
||||||
- name: Resolve docker image tag for push
|
|
||||||
if: github.event_name == 'push'
|
|
||||||
run: echo "HAK_DOCKER_IMAGE=$HAK_DOCKER_IMAGE:$GITHUB_REF_NAME" >> $GITHUB_ENV
|
|
||||||
- name: Resolve docker image tag for release
|
|
||||||
if: github.event_name == 'release'
|
|
||||||
run: echo "HAK_DOCKER_IMAGE=$HAK_DOCKER_IMAGE:staging" >> $GITHUB_ENV
|
|
||||||
- name: Resolve docker image tag for other triggers
|
|
||||||
if: github.event_name != 'push' && github.event_name != 'release'
|
|
||||||
run: echo "HAK_DOCKER_IMAGE=$HAK_DOCKER_IMAGE:develop" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- uses: nbucic/variable-mapper@0673f6891a0619ba7c002ecfed0f9f4f39017b6f
|
|
||||||
id: config
|
|
||||||
with:
|
|
||||||
key: "${{ inputs.arch }}"
|
|
||||||
export_to: output
|
|
||||||
map: |
|
|
||||||
{
|
|
||||||
"amd64": {
|
|
||||||
"target": "x86_64-unknown-linux-gnu",
|
|
||||||
"arch": "x86-64"
|
|
||||||
},
|
|
||||||
"arm64": {
|
|
||||||
"target": "aarch64-unknown-linux-gnu",
|
|
||||||
"arch": "aarch64",
|
|
||||||
"build-args": "--arm64"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/download-artifact@v4
|
|
||||||
with:
|
|
||||||
name: webapp
|
|
||||||
|
|
||||||
- name: Cache .hak
|
|
||||||
id: cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
key: ${{ runner.os }}-${{ github.ref_name }}-${{ inputs.sqlcipher }}-${{ inputs.arch }}-${{ hashFiles('hakHash', 'electronVersion', 'dockerbuild/*') }}
|
|
||||||
path: |
|
|
||||||
./.hak
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: "yarn"
|
|
||||||
env:
|
|
||||||
# Workaround for https://github.com/actions/setup-node/issues/317
|
|
||||||
FORCE_COLOR: 0
|
|
||||||
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: "Get modified files"
|
|
||||||
id: changed_files
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true' && github.event_name == 'pull_request'
|
|
||||||
uses: tj-actions/changed-files@dcc7a0cba800f454d79fff4b993e8c3555bcc0a8 # v45
|
|
||||||
with:
|
|
||||||
files: |
|
|
||||||
dockerbuild/**
|
|
||||||
|
|
||||||
# This allows contributors to test changes to the dockerbuild image within a pull request
|
|
||||||
- name: Build docker image
|
|
||||||
uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
|
|
||||||
if: steps.changed_files.outputs.any_modified == 'true'
|
|
||||||
with:
|
|
||||||
file: dockerbuild/Dockerfile
|
|
||||||
load: true
|
|
||||||
platforms: linux/${{ inputs.arch }}
|
|
||||||
tags: ${{ env.HAK_DOCKER_IMAGE }}
|
|
||||||
|
|
||||||
- name: Build Natives
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
docker run \
|
|
||||||
-v ${{ github.workspace }}:/work -w /work \
|
|
||||||
-e SQLCIPHER_BUNDLED \
|
|
||||||
$HAK_DOCKER_IMAGE \
|
|
||||||
yarn build:native
|
|
||||||
|
|
||||||
- name: Fix permissions on .hak
|
|
||||||
run: sudo chown -R $USER:$USER .hak
|
|
||||||
|
|
||||||
- name: Check native libraries in hak dependencies
|
|
||||||
run: |
|
|
||||||
shopt -s globstar
|
|
||||||
|
|
||||||
for filename in ./.hak/hakModules/**/*.node; do
|
|
||||||
./scripts/glibc-check.sh $filename
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Generate debian files and arguments
|
|
||||||
run: |
|
|
||||||
if [ -f changelog.Debian ]; then
|
|
||||||
echo "ED_DEBIAN_CHANGELOG=changelog.Debian" >> $GITHUB_ENV
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Workaround for https://github.com/electron-userland/electron-builder/issues/6116
|
|
||||||
- name: Install fpm
|
|
||||||
if: inputs.arch == 'arm64'
|
|
||||||
run: |
|
|
||||||
sudo apt-get install ruby-dev build-essential
|
|
||||||
sudo gem install fpm
|
|
||||||
echo "USE_SYSTEM_FPM=true" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- name: Build App
|
|
||||||
run: yarn build --publish never -l ${{ steps.config.outputs.build-args }}
|
|
||||||
env:
|
|
||||||
# Only set for Nightly builds
|
|
||||||
ED_NIGHTLY: ${{ inputs.version }}
|
|
||||||
|
|
||||||
- name: Check native libraries
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
shopt -s globstar
|
|
||||||
|
|
||||||
FILES=$(file dist/**/*.node)
|
|
||||||
echo "$FILES"
|
|
||||||
|
|
||||||
if [ grep -v "$ARCH" ]; then
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
LIBS=$(readelf -d dist/**/*.node | grep NEEDED)
|
|
||||||
echo "$LIBS"
|
|
||||||
|
|
||||||
set +x
|
|
||||||
assert_contains_string() { [[ "$1" == *"$2"* ]]; }
|
|
||||||
! assert_contains_string "$LIBS" "libcrypto.so.1.1"
|
|
||||||
if [ "$SQLCIPHER_BUNDLED" == "1" ]; then
|
|
||||||
! assert_contains_string "$LIBS" "libsqlcipher.so.0"
|
|
||||||
else
|
|
||||||
assert_contains_string "$LIBS" "libsqlcipher.so.0"
|
|
||||||
fi
|
|
||||||
|
|
||||||
./scripts/glibc-check.sh dist/linux-*unpacked/element-desktop*
|
|
||||||
env:
|
|
||||||
ARCH: ${{ steps.config.outputs.arch }}
|
|
||||||
|
|
||||||
# We exclude *-unpacked as it loses permissions and the tarball contains it with correct permissions
|
|
||||||
- name: Upload Artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: linux-${{ inputs.arch }}-sqlcipher-${{ inputs.sqlcipher }}
|
|
||||||
path: |
|
|
||||||
dist
|
|
||||||
!dist/*-unpacked/**
|
|
||||||
retention-days: 1
|
|
||||||
|
|
||||||
- name: Assert all required files are present
|
|
||||||
run: |
|
|
||||||
test -f ./dist/element-desktop*$ARCH.deb
|
|
||||||
test -f ./dist/element-desktop*.tar.gz
|
|
||||||
env:
|
|
||||||
ARCH: ${{ inputs.arch }}
|
|
||||||
147
.github/workflows/build_macos.yaml
vendored
147
.github/workflows/build_macos.yaml
vendored
@ -1,147 +0,0 @@
|
|||||||
# This workflow relies on actions/cache to store the hak dependency artifacts as they take a long time to build
|
|
||||||
# Due to this extra care must be taken to only ever run all build_* scripts against the same branch to ensure
|
|
||||||
# the correct cache scoping, and additional care must be taken to not run untrusted actions on the develop branch.
|
|
||||||
on:
|
|
||||||
workflow_call:
|
|
||||||
secrets:
|
|
||||||
APPLE_ID:
|
|
||||||
required: false
|
|
||||||
APPLE_ID_PASSWORD:
|
|
||||||
required: false
|
|
||||||
APPLE_TEAM_ID:
|
|
||||||
required: false
|
|
||||||
APPLE_CSC_KEY_PASSWORD:
|
|
||||||
required: false
|
|
||||||
APPLE_CSC_LINK:
|
|
||||||
required: false
|
|
||||||
inputs:
|
|
||||||
version:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "Version string to override the one in package.json, used for non-release builds"
|
|
||||||
sign:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "Whether to sign & notarise the build, requires 'packages.element.io' environment"
|
|
||||||
base-url:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "The URL to which the output will be deployed."
|
|
||||||
permissions: {} # No permissions required
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: macos-14 # M1
|
|
||||||
environment: ${{ inputs.sign && 'packages.element.io' || '' }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/download-artifact@v4
|
|
||||||
with:
|
|
||||||
name: webapp
|
|
||||||
|
|
||||||
- name: Cache .hak
|
|
||||||
id: cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
key: ${{ runner.os }}-${{ hashFiles('hakHash', 'electronVersion') }}
|
|
||||||
path: |
|
|
||||||
./.hak
|
|
||||||
|
|
||||||
- name: Install Rust
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
rustup toolchain install stable --profile minimal --no-self-update
|
|
||||||
rustup default stable
|
|
||||||
rustup target add aarch64-apple-darwin
|
|
||||||
rustup target add x86_64-apple-darwin
|
|
||||||
|
|
||||||
# M1 macos-14 comes without Python preinstalled
|
|
||||||
- uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: "3.12"
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
# Python 3.12 drops distutils which keytar relies on
|
|
||||||
- name: Install setuptools
|
|
||||||
run: pip3 install setuptools
|
|
||||||
|
|
||||||
- name: Build Natives
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
run: yarn build:native:universal
|
|
||||||
|
|
||||||
# We split these because electron-builder gets upset if we set CSC_LINK even to an empty string
|
|
||||||
- name: "[Signed] Build App"
|
|
||||||
if: inputs.sign != ''
|
|
||||||
run: |
|
|
||||||
yarn build:universal --publish never
|
|
||||||
env:
|
|
||||||
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
|
|
||||||
APPLE_ID: ${{ secrets.APPLE_ID }}
|
|
||||||
APPLE_APP_SPECIFIC_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
|
|
||||||
CSC_KEY_PASSWORD: ${{ secrets.APPLE_CSC_KEY_PASSWORD }}
|
|
||||||
CSC_LINK: ${{ secrets.APPLE_CSC_LINK }}
|
|
||||||
# Only set for Nightly builds
|
|
||||||
ED_NIGHTLY: ${{ inputs.version }}
|
|
||||||
|
|
||||||
- name: Check app was signed & notarised successfully
|
|
||||||
if: inputs.sign != ''
|
|
||||||
run: |
|
|
||||||
hdiutil attach dist/*.dmg -mountpoint /Volumes/Element
|
|
||||||
codesign -dv --verbose=4 /Volumes/Element/*.app
|
|
||||||
spctl -a -vvv -t install /Volumes/Element/*.app
|
|
||||||
hdiutil detach /Volumes/Element
|
|
||||||
|
|
||||||
- name: "[Unsigned] Build App"
|
|
||||||
if: inputs.sign == ''
|
|
||||||
run: |
|
|
||||||
yarn build:universal --publish never
|
|
||||||
env:
|
|
||||||
CSC_IDENTITY_AUTO_DISCOVERY: false
|
|
||||||
|
|
||||||
- name: Generate releases.json
|
|
||||||
if: inputs.base-url
|
|
||||||
run: |
|
|
||||||
PKG_JSON_VERSION=$(cat package.json | jq -r .version)
|
|
||||||
LATEST=$(find dist -type f -iname "*-mac.zip" | xargs -0 -n1 -- basename)
|
|
||||||
# Encode spaces in the URL as Squirrel.Mac complains about bad JSON otherwise
|
|
||||||
URL="${{ inputs.base-url }}/update/macos/${LATEST// /%20}"
|
|
||||||
|
|
||||||
jq -n --arg version "${VERSION:-$PKG_JSON_VERSION}" --arg url "$URL" '
|
|
||||||
{
|
|
||||||
currentRelease: $version,
|
|
||||||
releases: [{
|
|
||||||
version: $version,
|
|
||||||
updateTo: {
|
|
||||||
version: $version,
|
|
||||||
url: $url,
|
|
||||||
},
|
|
||||||
}],
|
|
||||||
}
|
|
||||||
' > dist/releases.json
|
|
||||||
jq -n --arg url "$URL" '
|
|
||||||
{ url: $url }
|
|
||||||
' > dist/releases-legacy.json
|
|
||||||
env:
|
|
||||||
VERSION: ${{ inputs.version }}
|
|
||||||
|
|
||||||
# We exclude mac-universal as the unpacked app takes forever to upload and zip and dmg already contains it
|
|
||||||
- name: Upload Artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: macos
|
|
||||||
path: |
|
|
||||||
dist
|
|
||||||
!dist/mac-universal/**
|
|
||||||
retention-days: 1
|
|
||||||
|
|
||||||
- name: Assert all required files are present
|
|
||||||
run: |
|
|
||||||
test -f ./dist/Element*.dmg
|
|
||||||
test -f ./dist/Element*-mac.zip
|
|
||||||
151
.github/workflows/build_prepare.yaml
vendored
151
.github/workflows/build_prepare.yaml
vendored
@ -1,151 +0,0 @@
|
|||||||
# This action helps perform common actions before the build_* actions are started in parallel.
|
|
||||||
on:
|
|
||||||
workflow_call:
|
|
||||||
inputs:
|
|
||||||
config:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: "The config directory to use"
|
|
||||||
version:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "The version tag to fetch, or 'develop', will pick automatically if not passed"
|
|
||||||
nightly:
|
|
||||||
type: boolean
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
description: "Whether the build is a Nightly and to calculate the version strings new builds should use"
|
|
||||||
deploy:
|
|
||||||
type: boolean
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
description: "Whether the build should be deployed to production"
|
|
||||||
secrets:
|
|
||||||
# Required if `nightly` is set
|
|
||||||
CF_R2_ACCESS_KEY_ID:
|
|
||||||
required: false
|
|
||||||
# Required if `nightly` is set
|
|
||||||
CF_R2_TOKEN:
|
|
||||||
required: false
|
|
||||||
outputs:
|
|
||||||
nightly-version:
|
|
||||||
description: "The version string the next Nightly should use, only output for nightly"
|
|
||||||
value: ${{ jobs.prepare.outputs.nightly-version }}
|
|
||||||
packages-dir:
|
|
||||||
description: "The directory non-deb packages for this run should live in within packages.element.io"
|
|
||||||
value: ${{ inputs.nightly && 'nightly' || 'desktop' }}
|
|
||||||
# This is just a simple pass-through of the input to simplify reuse of complex inline conditions
|
|
||||||
deploy:
|
|
||||||
description: "Whether the build should be deployed to production"
|
|
||||||
value: ${{ inputs.deploy }}
|
|
||||||
permissions: {}
|
|
||||||
jobs:
|
|
||||||
prepare:
|
|
||||||
name: Prepare
|
|
||||||
environment: ${{ inputs.nightly && 'packages.element.io' || '' }}
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
outputs:
|
|
||||||
nightly-version: ${{ steps.versions.outputs.nightly }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: Fetch Element Web
|
|
||||||
run: yarn run fetch --noverify -d ${{ inputs.config }} ${{ inputs.version }}
|
|
||||||
|
|
||||||
# We split this out to save the build_* scripts having to do it to make use of `hashFiles` in the cache action
|
|
||||||
- name: Generate cache hash files
|
|
||||||
run: |
|
|
||||||
# Add --no-sandbox as otherwise it fails because the helper isn't setuid root. It's only getting the version.
|
|
||||||
yarn run --silent electron --no-sandbox --version > electronVersion
|
|
||||||
cat package.json | jq -c .hakDependencies | sha1sum > hakHash
|
|
||||||
find hak -type f -print0 | xargs -0 sha1sum >> hakHash
|
|
||||||
find scripts/hak -type f -print0 | xargs -0 sha1sum >> hakHash
|
|
||||||
|
|
||||||
- name: "[Nightly] Calculate version"
|
|
||||||
id: versions
|
|
||||||
if: inputs.nightly
|
|
||||||
run: |
|
|
||||||
# Find all latest Nightly versions
|
|
||||||
aws s3 cp s3://$R2_BUCKET/nightly/update/macos/releases.json - --endpoint-url $R2_URL --region auto | jq -r .currentRelease >> VERSIONS
|
|
||||||
aws s3 cp s3://$R2_BUCKET/debian/dists/default/main/binary-amd64/Packages - --endpoint-url $R2_URL --region auto | grep "Package: element-nightly" -A 50 | grep Version -m1 | sed -n 's/Version: //p' >> VERSIONS
|
|
||||||
aws s3 cp s3://$R2_BUCKET/debian/dists/default/main/binary-arm64/Packages - --endpoint-url $R2_URL --region auto | grep "Package: element-nightly" -A 50 | grep Version -m1 | sed -n 's/Version: //p' >> VERSIONS
|
|
||||||
aws s3 cp s3://$R2_BUCKET/nightly/update/win32/x64/RELEASES - --endpoint-url $R2_URL --region auto | awk '{print $2}' | cut -d "-" -f 5 | cut -c 8- >> VERSIONS
|
|
||||||
aws s3 cp s3://$R2_BUCKET/nightly/update/win32/ia32/RELEASES - --endpoint-url $R2_URL --region auto | awk '{print $2}' | cut -d "-" -f 5 | cut -c 8- >> VERSIONS
|
|
||||||
|
|
||||||
# Pick the greatest one
|
|
||||||
VERSION=$(cat VERSIONS | sort -uf | tail -n1)
|
|
||||||
echo "Found latest nightly version $VERSION"
|
|
||||||
# Increment it
|
|
||||||
echo "nightly=$(scripts/generate-nightly-version.ts --latest $VERSION)" >> $GITHUB_OUTPUT
|
|
||||||
env:
|
|
||||||
AWS_ACCESS_KEY_ID: ${{ secrets.CF_R2_ACCESS_KEY_ID }}
|
|
||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.CF_R2_TOKEN }}
|
|
||||||
# Workaround for https://www.cloudflarestatus.com/incidents/t5nrjmpxc1cj
|
|
||||||
AWS_REQUEST_CHECKSUM_CALCULATION: when_required
|
|
||||||
R2_BUCKET: ${{ vars.R2_BUCKET }}
|
|
||||||
R2_URL: ${{ vars.CF_R2_S3_API }}
|
|
||||||
|
|
||||||
- name: Check version
|
|
||||||
id: package
|
|
||||||
run: |
|
|
||||||
echo "version=$(cat package.json | jq -r .version)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: "[Release] Fetch release"
|
|
||||||
id: release
|
|
||||||
if: ${{ !inputs.nightly && inputs.version != 'develop' }}
|
|
||||||
uses: cardinalby/git-get-release-action@cedef2faf69cb7c55b285bad07688d04430b7ada # v1
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ github.token }}
|
|
||||||
with:
|
|
||||||
tag: v${{ steps.package.outputs.version }}
|
|
||||||
|
|
||||||
- name: "[Release] Write changelog"
|
|
||||||
if: ${{ !inputs.nightly && inputs.version != 'develop' }}
|
|
||||||
run: |
|
|
||||||
TIME=$(date -d "$PUBLISHED_AT" -R)
|
|
||||||
echo "element-desktop ($VERSION) default; urgency=medium" >> changelog.Debian
|
|
||||||
echo "$BODY" | sed 's/^##/\n */g;s/^\*/ */g' | perl -pe 's/\[.+?]\((.+?)\)/\1/g' >> changelog.Debian
|
|
||||||
echo "" >> changelog.Debian
|
|
||||||
echo " -- $ACTOR <support@element.io> $TIME" >> changelog.Debian
|
|
||||||
env:
|
|
||||||
ACTOR: ${{ github.actor }}
|
|
||||||
VERSION: v${{ steps.package.outputs.version }}
|
|
||||||
BODY: ${{ steps.release.outputs.body }}
|
|
||||||
PUBLISHED_AT: ${{ steps.release.outputs.published_at }}
|
|
||||||
|
|
||||||
- name: "[Nightly] Write summary"
|
|
||||||
if: inputs.nightly
|
|
||||||
run: |
|
|
||||||
BUNDLE_HASH=$(npx asar l webapp.asar | grep /bundles/ | head -n 1 | sed 's|.*/||')
|
|
||||||
WEBAPP_VERSION=$(./scripts/get-version.ts)
|
|
||||||
WEB_VERSION=${WEBAPP_VERSION:0:12}
|
|
||||||
JS_VERSION=${WEBAPP_VERSION:16:12}
|
|
||||||
|
|
||||||
echo "### Nightly build ${{ steps.versions.outputs.nightly }}" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "| Component | Version |" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "| ----------- | ------- |" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "| Bundle Hash | $BUNDLE_HASH |" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "| Element Web | [$WEB_VERSION](https://github.com/element-hq/element-web/commit/$WEB_VERSION) |" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "| JS SDK | [$JS_VERSION](https://github.com/matrix-org/matrix-js-sdk/commit/$JS_VERSION) |" >> $GITHUB_STEP_SUMMARY
|
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: webapp
|
|
||||||
retention-days: 1
|
|
||||||
path: |
|
|
||||||
webapp.asar
|
|
||||||
package.json
|
|
||||||
electronVersion
|
|
||||||
hakHash
|
|
||||||
changelog.Debian
|
|
||||||
218
.github/workflows/build_windows.yaml
vendored
218
.github/workflows/build_windows.yaml
vendored
@ -1,218 +0,0 @@
|
|||||||
# This workflow relies on actions/cache to store the hak dependency artifacts as they take a long time to build
|
|
||||||
# Due to this extra care must be taken to only ever run all build_* scripts against the same branch to ensure
|
|
||||||
# the correct cache scoping, and additional care must be taken to not run untrusted actions on the develop branch.
|
|
||||||
|
|
||||||
# Windows GHA runner by default uses the pwsh shell which breaks codeSigningCert in the workflow
|
|
||||||
# We always sign using eSignerCKA to ensure it keeps working, but aside from release & nightlies we use demo credentials
|
|
||||||
# which do not yield trusted signatures.
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: powershell
|
|
||||||
on:
|
|
||||||
workflow_call:
|
|
||||||
secrets:
|
|
||||||
ESIGNER_USER_NAME:
|
|
||||||
required: false
|
|
||||||
ESIGNER_USER_PASSWORD:
|
|
||||||
required: false
|
|
||||||
ESIGNER_USER_TOTP:
|
|
||||||
required: false
|
|
||||||
inputs:
|
|
||||||
arch:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: "The architecture to build for, one of 'x64' | 'ia32' | 'arm64'"
|
|
||||||
version:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "Version string to override the one in package.json, used for non-release builds"
|
|
||||||
sign:
|
|
||||||
type: string
|
|
||||||
required: false
|
|
||||||
description: "Whether to sign & notarise the build, requires 'packages.element.io' environment"
|
|
||||||
permissions: {} # No permissions required
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: windows-2022
|
|
||||||
environment: ${{ inputs.sign && 'packages.element.io' || '' }}
|
|
||||||
env:
|
|
||||||
SIGNTOOL_PATH: "C:/Program Files (x86)/Windows Kits/10/bin/10.0.22000.0/x86/signtool.exe"
|
|
||||||
steps:
|
|
||||||
- uses: nbucic/variable-mapper@0673f6891a0619ba7c002ecfed0f9f4f39017b6f
|
|
||||||
id: config
|
|
||||||
with:
|
|
||||||
key: "${{ inputs.arch }}"
|
|
||||||
export_to: output
|
|
||||||
map: |
|
|
||||||
{
|
|
||||||
"x64": {
|
|
||||||
"target": "x86_64-pc-windows-msvc"
|
|
||||||
},
|
|
||||||
"arm64": {
|
|
||||||
"target": "aarch64-pc-windows-msvc",
|
|
||||||
"build-args": "--arm64",
|
|
||||||
"arch": "amd64_arm64"
|
|
||||||
},
|
|
||||||
"ia32": {
|
|
||||||
"target": "i686-pc-windows-msvc",
|
|
||||||
"build-args": "--ia32",
|
|
||||||
"arch": "x86",
|
|
||||||
"extra_config": "{\"user_notice\": {\"title\": \"Your desktop support ends soon\",\"description\": \"Support for 32-bit Windows installations will end soon, this impacts you. Transition to the web or mobile app for continued access.\"}}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/download-artifact@v4
|
|
||||||
with:
|
|
||||||
name: webapp
|
|
||||||
|
|
||||||
- name: Cache .hak
|
|
||||||
id: cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
key: ${{ runner.os }}-${{ inputs.arch }}-${{ hashFiles('hakHash', 'electronVersion') }}
|
|
||||||
path: |
|
|
||||||
./.hak
|
|
||||||
|
|
||||||
# ActiveTCL package on choco is from 2015,
|
|
||||||
# this one is newer but includes more than we need
|
|
||||||
- name: Choco install tclsh
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
shell: pwsh
|
|
||||||
run: |
|
|
||||||
choco install -y magicsplat-tcl-tk --no-progress
|
|
||||||
echo "${HOME}/AppData/Local/Apps/Tcl86/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
|
|
||||||
|
|
||||||
- name: Choco install NetWide Assembler
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
shell: pwsh
|
|
||||||
run: |
|
|
||||||
choco install -y nasm --no-progress
|
|
||||||
echo "C:/Program Files/NASM" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
|
|
||||||
|
|
||||||
- name: Install Rust
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
rustup toolchain install stable --profile minimal --no-self-update
|
|
||||||
rustup default stable
|
|
||||||
rustup target add ${{ steps.config.outputs.target }}
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: Insert config snippet
|
|
||||||
if: steps.config.outputs.extra_config != ''
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
mkdir config-edit
|
|
||||||
yarn asar extract webapp.asar config-edit
|
|
||||||
cd config-edit
|
|
||||||
mv config.json old-config.json
|
|
||||||
echo '${{ steps.config.outputs.extra_config }}' | jq -s '.[0] * .[1]' old-config.json - > config.json
|
|
||||||
rm old-config.json
|
|
||||||
cd ..
|
|
||||||
rm webapp.asar
|
|
||||||
yarn asar pack config-edit/ webapp.asar
|
|
||||||
|
|
||||||
- name: Set up sqlcipher macros
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true' && contains(inputs.arch, 'arm')
|
|
||||||
shell: pwsh
|
|
||||||
run: |
|
|
||||||
echo "NCC=${{ github.workspace }}\scripts\cl.bat" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
|
||||||
|
|
||||||
- name: Set up build tools
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
|
||||||
with:
|
|
||||||
arch: ${{ steps.config.outputs.arch || inputs.arch }}
|
|
||||||
|
|
||||||
- name: Build Natives
|
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
refreshenv
|
|
||||||
yarn build:native --target ${{ steps.config.outputs.target }}
|
|
||||||
|
|
||||||
- name: Install and configure eSigner CKA
|
|
||||||
run: |
|
|
||||||
Set-StrictMode -Version 'Latest'
|
|
||||||
|
|
||||||
# Download, extract, and rename
|
|
||||||
Invoke-WebRequest -OutFile eSigner_CKA.zip "$env:ESIGNER_URL"
|
|
||||||
Expand-Archive -Path eSigner_CKA.zip -DestinationPath .
|
|
||||||
Get-ChildItem -Path * -Include "*_build_*.exe" | Rename-Item -NewName eSigner_CKA.exe
|
|
||||||
|
|
||||||
# Install
|
|
||||||
New-Item -ItemType Directory -Force -Path "$env:INSTALL_DIR"
|
|
||||||
./eSigner_CKA.exe /CURRENTUSER /VERYSILENT /SUPPRESSMSGBOXES /DIR="${{ env.INSTALL_DIR }}" | Out-Null
|
|
||||||
|
|
||||||
# Disable logger
|
|
||||||
$LogConfig = Get-Content -Path ${{ env.INSTALL_DIR }}/log4net.config
|
|
||||||
$LogConfig[0] = '<log4net threshold="OFF">'
|
|
||||||
$LogConfig | Set-Content -Path ${{ env.INSTALL_DIR }}/log4net.config
|
|
||||||
|
|
||||||
# Configure - default credentials from https://www.ssl.com/guide/esigner-demo-credentials-and-certificates/
|
|
||||||
${{ env.INSTALL_DIR }}/eSignerCKATool.exe config `
|
|
||||||
-mode ${{ vars.ESIGNER_MODE || 'sandbox' }} `
|
|
||||||
-user "${{ secrets.ESIGNER_USER_NAME || 'esigner_demo' }}" `
|
|
||||||
-pass "${{ secrets.ESIGNER_USER_PASSWORD || 'esignerDemo#1' }}" `
|
|
||||||
-totp "${{ secrets.ESIGNER_USER_TOTP || 'RDXYgV9qju+6/7GnMf1vCbKexXVJmUVr+86Wq/8aIGg=' }}" `
|
|
||||||
-key "${{ env.MASTER_KEY_FILE }}" -r
|
|
||||||
${{ env.INSTALL_DIR }}/eSignerCKATool.exe unload
|
|
||||||
${{ env.INSTALL_DIR }}/eSignerCKATool.exe load
|
|
||||||
|
|
||||||
# Find certificate
|
|
||||||
$CodeSigningCert = Get-ChildItem Cert:\CurrentUser\My -CodeSigningCert | Select-Object -First 1
|
|
||||||
echo Certificate: $CodeSigningCert
|
|
||||||
|
|
||||||
# Extract thumbprint and subject name
|
|
||||||
$Thumbprint = $CodeSigningCert.Thumbprint
|
|
||||||
$SubjectName = ($CodeSigningCert.Subject -replace ", ?", "`n" | ConvertFrom-StringData).CN
|
|
||||||
|
|
||||||
echo "ED_SIGNTOOL_THUMBPRINT=$Thumbprint" >> $env:GITHUB_ENV
|
|
||||||
echo "ED_SIGNTOOL_SUBJECT_NAME=$SubjectName" >> $env:GITHUB_ENV
|
|
||||||
env:
|
|
||||||
ESIGNER_URL: https://github.com/SSLcom/eSignerCKA/releases/download/v1.0.6/SSL.COM-eSigner-CKA_1.0.6.zip
|
|
||||||
INSTALL_DIR: C:\Users\runneradmin\eSignerCKA
|
|
||||||
MASTER_KEY_FILE: C:\Users\runneradmin\eSignerCKA\master.key
|
|
||||||
|
|
||||||
- name: Build App
|
|
||||||
run: yarn build --publish never -w ${{ steps.config.outputs.build-args }}
|
|
||||||
env:
|
|
||||||
# Only set for Nightly builds
|
|
||||||
ED_NIGHTLY: ${{ inputs.version }}
|
|
||||||
|
|
||||||
- name: Trust eSigner sandbox cert
|
|
||||||
if: inputs.sign == ''
|
|
||||||
run: |
|
|
||||||
Set-StrictMode -Version 'Latest'
|
|
||||||
Import-Certificate -CertStoreLocation Cert:\LocalMachine\Root -FilePath .github/SSLcom-sandbox.crt
|
|
||||||
|
|
||||||
- name: Check app was signed successfully
|
|
||||||
run: |
|
|
||||||
Set-StrictMode -Version 'Latest'
|
|
||||||
Get-ChildItem `
|
|
||||||
-Recurse dist `
|
|
||||||
-Include *.exe, *.msi `
|
|
||||||
| ForEach-Object -Process {. $env:SIGNTOOL_PATH verify /pa $_.FullName; if(!$?) { throw }}
|
|
||||||
|
|
||||||
- name: Upload Artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: win-${{ inputs.arch }}
|
|
||||||
path: |
|
|
||||||
dist
|
|
||||||
retention-days: 1
|
|
||||||
|
|
||||||
- name: Assert all required files are present
|
|
||||||
run: |
|
|
||||||
Test-Path './dist/win-*unpacked/Element*.exe'
|
|
||||||
Test-Path './dist/squirrel-windows*/Element Setup*.exe'
|
|
||||||
Test-Path './dist/squirrel-windows*/element-desktop-*-full.nupkg'
|
|
||||||
Test-Path './dist/squirrel-windows*/RELEASES'
|
|
||||||
Test-Path './dist/Element*.msi'
|
|
||||||
70
.github/workflows/dockerbuild.yaml
vendored
70
.github/workflows/dockerbuild.yaml
vendored
@ -1,70 +0,0 @@
|
|||||||
name: Dockerbuild
|
|
||||||
on:
|
|
||||||
workflow_dispatch: {}
|
|
||||||
push:
|
|
||||||
branches: [master, staging, develop]
|
|
||||||
paths:
|
|
||||||
- "dockerbuild/**"
|
|
||||||
pull_request:
|
|
||||||
concurrency: ${{ github.workflow }}-${{ github.ref_name }}
|
|
||||||
env:
|
|
||||||
REGISTRY: ghcr.io
|
|
||||||
IMAGE_NAME: ${{ github.repository }}-dockerbuild
|
|
||||||
permissions: {}
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
name: Docker Build
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3
|
|
||||||
with:
|
|
||||||
install: true
|
|
||||||
|
|
||||||
- name: Build test image
|
|
||||||
uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
|
|
||||||
with:
|
|
||||||
file: dockerbuild/Dockerfile
|
|
||||||
push: false
|
|
||||||
load: true
|
|
||||||
tags: element-desktop-dockerbuild
|
|
||||||
platforms: linux/amd64
|
|
||||||
|
|
||||||
- name: Test image
|
|
||||||
run: docker run -v $PWD:/project element-desktop-dockerbuild yarn install
|
|
||||||
|
|
||||||
- name: Log in to the Container registry
|
|
||||||
uses: docker/login-action@327cd5a69de6c009b9ce71bce8395f28e651bf99
|
|
||||||
if: github.event_name != 'pull_request'
|
|
||||||
with:
|
|
||||||
registry: ${{ env.REGISTRY }}
|
|
||||||
username: ${{ github.actor }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Extract metadata for Docker
|
|
||||||
id: meta
|
|
||||||
if: github.event_name != 'pull_request'
|
|
||||||
uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5
|
|
||||||
with:
|
|
||||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
|
||||||
tags: |
|
|
||||||
type=ref,event=branch
|
|
||||||
type=ref,event=pr
|
|
||||||
|
|
||||||
- name: Build and push Docker image
|
|
||||||
if: github.event_name != 'pull_request'
|
|
||||||
uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
|
|
||||||
with:
|
|
||||||
file: dockerbuild/Dockerfile
|
|
||||||
push: true
|
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
12
.github/workflows/localazy_download.yaml
vendored
12
.github/workflows/localazy_download.yaml
vendored
@ -1,12 +0,0 @@
|
|||||||
name: Localazy Download
|
|
||||||
on:
|
|
||||||
workflow_dispatch: {}
|
|
||||||
schedule:
|
|
||||||
- cron: "0 6 * * 1,3,5" # Every Monday, Wednesday and Friday at 6am UTC
|
|
||||||
permissions:
|
|
||||||
pull-requests: write # needed to auto-approve PRs
|
|
||||||
jobs:
|
|
||||||
download:
|
|
||||||
uses: matrix-org/matrix-web-i18n/.github/workflows/localazy_download.yaml@main
|
|
||||||
secrets:
|
|
||||||
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
12
.github/workflows/localazy_upload.yaml
vendored
12
.github/workflows/localazy_upload.yaml
vendored
@ -1,12 +0,0 @@
|
|||||||
name: Localazy Upload
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [develop]
|
|
||||||
paths:
|
|
||||||
- "src/i18n/strings/en_EN.json"
|
|
||||||
permissions: {} # No permissions needed
|
|
||||||
jobs:
|
|
||||||
upload:
|
|
||||||
uses: matrix-org/matrix-web-i18n/.github/workflows/localazy_upload.yaml@main
|
|
||||||
secrets:
|
|
||||||
LOCALAZY_WRITE_KEY: ${{ secrets.LOCALAZY_WRITE_KEY }}
|
|
||||||
12
.github/workflows/pull_request.yaml
vendored
12
.github/workflows/pull_request.yaml
vendored
@ -1,12 +0,0 @@
|
|||||||
name: Pull Request
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
types: [opened, edited, labeled, unlabeled, synchronize]
|
|
||||||
permissions: {}
|
|
||||||
jobs:
|
|
||||||
action:
|
|
||||||
uses: matrix-org/matrix-js-sdk/.github/workflows/pull_request.yaml@develop
|
|
||||||
permissions:
|
|
||||||
pull-requests: write
|
|
||||||
secrets:
|
|
||||||
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
14
.github/workflows/release-drafter.yml
vendored
14
.github/workflows/release-drafter.yml
vendored
@ -1,14 +0,0 @@
|
|||||||
name: Release Drafter
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [staging]
|
|
||||||
workflow_dispatch: {}
|
|
||||||
concurrency: ${{ github.workflow }}
|
|
||||||
permissions: {}
|
|
||||||
jobs:
|
|
||||||
draft:
|
|
||||||
uses: matrix-org/matrix-js-sdk/.github/workflows/release-drafter-workflow.yml@develop
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
with:
|
|
||||||
include-changes: element-hq/element-web~$VERSION
|
|
||||||
12
.github/workflows/release-gitflow.yml
vendored
12
.github/workflows/release-gitflow.yml
vendored
@ -1,12 +0,0 @@
|
|||||||
# Gitflow merge-back master->develop
|
|
||||||
name: Merge master -> develop
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [master]
|
|
||||||
concurrency: ${{ github.repository }}-${{ github.workflow }}
|
|
||||||
permissions: {} # Uses ELEMENT_BOT_TOKEN
|
|
||||||
jobs:
|
|
||||||
merge:
|
|
||||||
uses: matrix-org/matrix-js-sdk/.github/workflows/release-gitflow.yml@develop
|
|
||||||
secrets:
|
|
||||||
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
46
.github/workflows/release.yml
vendored
46
.github/workflows/release.yml
vendored
@ -1,46 +0,0 @@
|
|||||||
name: Release Process
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
mode:
|
|
||||||
description: What type of release
|
|
||||||
required: true
|
|
||||||
default: rc
|
|
||||||
type: choice
|
|
||||||
options:
|
|
||||||
- rc
|
|
||||||
- final
|
|
||||||
concurrency: ${{ github.workflow }}
|
|
||||||
permissions: {}
|
|
||||||
jobs:
|
|
||||||
release:
|
|
||||||
uses: matrix-org/matrix-js-sdk/.github/workflows/release-make.yml@develop
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
issues: write
|
|
||||||
pull-requests: read
|
|
||||||
id-token: write
|
|
||||||
secrets:
|
|
||||||
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
|
|
||||||
GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
|
|
||||||
with:
|
|
||||||
final: ${{ inputs.mode == 'final' }}
|
|
||||||
gpg-fingerprint: ${{ vars.GPG_FINGERPRINT }}
|
|
||||||
expected-asset-count: 1
|
|
||||||
|
|
||||||
check:
|
|
||||||
name: Post release checks
|
|
||||||
needs: release
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
permissions:
|
|
||||||
checks: read
|
|
||||||
steps:
|
|
||||||
- name: Wait for desktop packaging
|
|
||||||
uses: t3chguy/wait-on-check-action@18541021811b56544d90e0f073401c2b99e249d6 # fork
|
|
||||||
with:
|
|
||||||
ref: master
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
wait-interval: 10
|
|
||||||
check-regexp: Prepare|Linux|macOS|Windows|Deploy|deploy
|
|
||||||
allowed-conclusions: success
|
|
||||||
85
.github/workflows/static_analysis.yaml
vendored
85
.github/workflows/static_analysis.yaml
vendored
@ -1,85 +0,0 @@
|
|||||||
name: Static Analysis
|
|
||||||
on:
|
|
||||||
pull_request: {}
|
|
||||||
push:
|
|
||||||
branches: [develop, master]
|
|
||||||
permissions: {} # No permissions needed
|
|
||||||
jobs:
|
|
||||||
ts_lint:
|
|
||||||
name: "Typescript Syntax Check"
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: package.json
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
# Does not need branch matching as only analyses this layer
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: Typecheck
|
|
||||||
run: "yarn run lint:types"
|
|
||||||
|
|
||||||
i18n_lint:
|
|
||||||
name: "i18n Check"
|
|
||||||
uses: matrix-org/matrix-web-i18n/.github/workflows/i18n_check.yml@main
|
|
||||||
permissions:
|
|
||||||
pull-requests: read
|
|
||||||
with:
|
|
||||||
hardcoded-words: "Element"
|
|
||||||
|
|
||||||
js_lint:
|
|
||||||
name: "ESLint"
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: package.json
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
# Does not need branch matching as only analyses this layer
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: Run Linter
|
|
||||||
run: "yarn run lint:js"
|
|
||||||
|
|
||||||
workflow_lint:
|
|
||||||
name: "Workflow Lint"
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: package.json
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
# Does not need branch matching as only analyses this layer
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: Run Linter
|
|
||||||
run: "yarn lint:workflows"
|
|
||||||
|
|
||||||
analyse_dead_code:
|
|
||||||
name: "Analyse Dead Code"
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: package.json
|
|
||||||
cache: "yarn"
|
|
||||||
|
|
||||||
- name: Install Deps
|
|
||||||
run: "yarn install --frozen-lockfile"
|
|
||||||
|
|
||||||
- name: Run linter
|
|
||||||
run: "yarn run lint:knip"
|
|
||||||
22
.github/workflows/sync-labels.yml
vendored
22
.github/workflows/sync-labels.yml
vendored
@ -1,22 +0,0 @@
|
|||||||
name: Sync labels
|
|
||||||
on:
|
|
||||||
workflow_dispatch: {}
|
|
||||||
schedule:
|
|
||||||
- cron: "0 2 * * *" # 2am every day
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- develop
|
|
||||||
paths:
|
|
||||||
- .github/labels.yml
|
|
||||||
permissions: {} # Uses ELEMENT_BOT_TOKEN
|
|
||||||
jobs:
|
|
||||||
sync-labels:
|
|
||||||
uses: element-hq/element-meta/.github/workflows/sync-labels.yml@develop
|
|
||||||
with:
|
|
||||||
LABELS: |
|
|
||||||
element-hq/element-web
|
|
||||||
.github/labels.yml
|
|
||||||
DELETE: true
|
|
||||||
WET: true
|
|
||||||
secrets:
|
|
||||||
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
16
.github/workflows/triage-incoming.yml
vendored
16
.github/workflows/triage-incoming.yml
vendored
@ -1,16 +0,0 @@
|
|||||||
name: Move new issues into Issue triage board
|
|
||||||
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types: [opened]
|
|
||||||
|
|
||||||
permissions: {} # Uses ELEMENT_BOT_TOKEN
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
automate-project-columns-next:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/add-to-project@main
|
|
||||||
with:
|
|
||||||
project-url: https://github.com/orgs/element-hq/projects/120
|
|
||||||
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
|
||||||
12
.github/workflows/triage-labelled.yml
vendored
12
.github/workflows/triage-labelled.yml
vendored
@ -1,12 +0,0 @@
|
|||||||
name: Move labelled issues to correct projects
|
|
||||||
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types: [labeled]
|
|
||||||
|
|
||||||
permissions: {} # Uses ELEMENT_BOT_TOKEN
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
call-triage-labelled:
|
|
||||||
uses: element-hq/element-web/.github/workflows/triage-labelled.yml@develop
|
|
||||||
secrets: inherit
|
|
||||||
22
.github/workflows/triage-stale.yml
vendored
22
.github/workflows/triage-stale.yml
vendored
@ -1,22 +0,0 @@
|
|||||||
name: Close stale PRs
|
|
||||||
on:
|
|
||||||
workflow_dispatch: {}
|
|
||||||
schedule:
|
|
||||||
- cron: "30 1 * * *"
|
|
||||||
permissions: {}
|
|
||||||
jobs:
|
|
||||||
close:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
permissions:
|
|
||||||
actions: write
|
|
||||||
issues: write
|
|
||||||
pull-requests: write
|
|
||||||
steps:
|
|
||||||
- uses: actions/stale@v9
|
|
||||||
with:
|
|
||||||
operations-per-run: 250
|
|
||||||
days-before-issue-stale: -1
|
|
||||||
days-before-issue-close: -1
|
|
||||||
days-before-pr-stale: 180
|
|
||||||
days-before-pr-close: 0
|
|
||||||
close-pr-message: "This PR has been automatically closed because it has been stale for 180 days. If you wish to continue working on this PR, please ping a maintainer to reopen it."
|
|
||||||
12
.gitignore
vendored
12
.gitignore
vendored
@ -1,20 +1,12 @@
|
|||||||
/dist
|
/dist
|
||||||
/lib
|
|
||||||
/webapp
|
/webapp
|
||||||
/webapp.asar
|
/webapp.asar
|
||||||
/packages
|
/packages
|
||||||
/deploys
|
/deploys
|
||||||
node_modules/
|
/node_modules
|
||||||
|
/docker_node_modules
|
||||||
/pkg/control
|
/pkg/control
|
||||||
/.hak
|
/.hak
|
||||||
/.yarnrc
|
/.yarnrc
|
||||||
/docker
|
/docker
|
||||||
/.npmrc
|
/.npmrc
|
||||||
.vscode
|
|
||||||
.vscode/
|
|
||||||
/test_artifacts/
|
|
||||||
/coverage/
|
|
||||||
yarn-error.log
|
|
||||||
/hak/**/*.js
|
|
||||||
/scripts/hak/**/*.js
|
|
||||||
.DS_Store
|
|
||||||
|
|||||||
@ -1,4 +0,0 @@
|
|||||||
#!/usr/bin/env sh
|
|
||||||
. "$(dirname "$0")/_/husky.sh"
|
|
||||||
|
|
||||||
npx lint-staged --concurrent false
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"*": "prettier --write",
|
|
||||||
"*.(ts|tsx)": ["eslint --fix"]
|
|
||||||
}
|
|
||||||
@ -1 +0,0 @@
|
|||||||
v22.14.0
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
/build/
|
|
||||||
/dockerbuild/
|
|
||||||
/lib/
|
|
||||||
/node_modules/
|
|
||||||
/packages.elememt.io/
|
|
||||||
/webapp
|
|
||||||
/src/i18n/strings
|
|
||||||
/CHANGELOG.md
|
|
||||||
/package-lock.json
|
|
||||||
/yarn.lock
|
|
||||||
/playwright/html-report
|
|
||||||
/playwright/test-results
|
|
||||||
|
|
||||||
**/.idea
|
|
||||||
.vscode
|
|
||||||
.vscode/
|
|
||||||
.tmp
|
|
||||||
.env
|
|
||||||
/coverage
|
|
||||||
/.npmrc
|
|
||||||
/*.log
|
|
||||||
@ -1 +0,0 @@
|
|||||||
module.exports = require("eslint-plugin-matrix-org/.prettierrc.js");
|
|
||||||
4197
CHANGELOG.md
4197
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@ -1,5 +0,0 @@
|
|||||||
# Contributing code to element-desktop
|
|
||||||
|
|
||||||
Everyone is welcome to contribute code to element-desktop, provided that they are willing to license their contributions to Element under a [Contributor License Agreement](https://cla-assistant.io/element-hq/element-desktop) (CLA). This ensures that their contribution will be made available under an approved licence(as described in the [README](/README.md#copyright--license)).
|
|
||||||
|
|
||||||
element-desktop follows the same pattern as element-web, please find more contributing guidelines at https://github.com/vector-im/element-web/blob/develop/CONTRIBUTING.md
|
|
||||||
201
LICENSE
Normal file
201
LICENSE
Normal file
@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
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.
|
||||||
661
LICENSE-AGPL-3.0
661
LICENSE-AGPL-3.0
@ -1,661 +0,0 @@
|
|||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works, specifically designed to ensure
|
|
||||||
cooperation with the community in the case of network server software.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
our General Public Licenses are 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.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
|
||||||
you this License which gives you legal permission to copy, distribute
|
|
||||||
and/or modify the software.
|
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
|
||||||
improvements made in alternate versions of the program, if they
|
|
||||||
receive widespread use, become available for other developers to
|
|
||||||
incorporate. Many developers of free software are heartened and
|
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
|
||||||
software used on network servers, this result may fail to come about.
|
|
||||||
The GNU General Public License permits making a modified version and
|
|
||||||
letting the public access it on a server without ever releasing its
|
|
||||||
source code to the public.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
|
||||||
ensure that, in such cases, the modified source code becomes available
|
|
||||||
to the community. It requires the operator of a network server to
|
|
||||||
provide the source code of the modified version running there to the
|
|
||||||
users of that server. Therefore, public use of a modified version, on
|
|
||||||
a publicly accessible server, gives the public access to the source
|
|
||||||
code of the modified version.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
|
||||||
this license.
|
|
||||||
|
|
||||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the
|
|
||||||
Program, your modified version must prominently offer all users
|
|
||||||
interacting with it remotely through a computer network (if your version
|
|
||||||
supports such interaction) an opportunity to receive the Corresponding
|
|
||||||
Source of your version by providing access to the Corresponding Source
|
|
||||||
from a network server at no charge, through some standard or customary
|
|
||||||
means of facilitating copying of software. This Corresponding Source
|
|
||||||
shall include the Corresponding Source for any work covered by version 3
|
|
||||||
of the GNU General Public License that is incorporated pursuant to the
|
|
||||||
following paragraph.
|
|
||||||
|
|
||||||
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 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 work with which it is combined will remain governed by version
|
|
||||||
3 of the GNU General Public License.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
|
||||||
network, you should also make sure that it provides a way for users to
|
|
||||||
get its source. For example, if your program is a web application, its
|
|
||||||
interface could display a "Source" link that leads users to an archive
|
|
||||||
of the code. There are many ways you could offer source, and different
|
|
||||||
solutions will be better for different programs; see section 13 for the
|
|
||||||
specific requirements.
|
|
||||||
|
|
||||||
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 AGPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
Licensees holding a valid commercial license with Element may use this
|
|
||||||
software in accordance with the terms contained in a written agreement
|
|
||||||
between you and Element.
|
|
||||||
|
|
||||||
To purchase a commercial license please contact our sales team at
|
|
||||||
licensing@element.io
|
|
||||||
674
LICENSE-GPL-3.0
674
LICENSE-GPL-3.0
@ -1,674 +0,0 @@
|
|||||||
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>.
|
|
||||||
124
README.md
124
README.md
@ -1,24 +1,18 @@
|
|||||||
|
Element Desktop
|
||||||
|
===============
|
||||||
[](https://localazy.com/p/element-web)
|
|
||||||
[](https://sonarcloud.io/summary/new_code?id=element-desktop)
|
|
||||||
[](https://sonarcloud.io/summary/new_code?id=element-desktop)
|
|
||||||
[](https://sonarcloud.io/summary/new_code?id=element-desktop)
|
|
||||||
|
|
||||||
# Element Desktop
|
|
||||||
|
|
||||||
Element Desktop is a Matrix client for desktop platforms with Element Web at its core.
|
Element Desktop is a Matrix client for desktop platforms with Element Web at its core.
|
||||||
|
|
||||||
# First Steps
|
First Steps
|
||||||
|
===========
|
||||||
Before you do anything else, fetch the dependencies:
|
Before you do anything else, fetch the dependencies:
|
||||||
|
|
||||||
```
|
```
|
||||||
yarn install
|
yarn install
|
||||||
```
|
```
|
||||||
|
|
||||||
# Fetching Element
|
Fetching Element
|
||||||
|
================
|
||||||
Since this package is just the Electron wrapper for Element Web, it doesn't contain any of the Element Web code,
|
Since this package is just the Electron wrapper for Element Web, it doesn't contain any of the Element Web code,
|
||||||
so the first step is to get a working copy of Element Web. There are a few ways of doing this:
|
so the first step is to get a working copy of Element Web. There are a few ways of doing this:
|
||||||
|
|
||||||
@ -26,31 +20,28 @@ so the first step is to get a working copy of Element Web. There are a few ways
|
|||||||
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version
|
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version
|
||||||
# fetched will be the same as the local element-desktop package.
|
# fetched will be the same as the local element-desktop package.
|
||||||
# We're explicitly asking for no config, so the packaged Element will have no config.json.
|
# We're explicitly asking for no config, so the packaged Element will have no config.json.
|
||||||
yarn run fetch --noverify --cfgdir ""
|
yarn run fetch --noverify --cfgdir ''
|
||||||
```
|
```
|
||||||
|
|
||||||
...or if you'd like to use GPG to verify the downloaded package:
|
...or if you'd like to use GPG to verify the downloaded package:
|
||||||
|
|
||||||
```
|
```
|
||||||
# Fetch the Element public key from the element.io web server over a secure connection and import
|
# Fetch the Element public key from the element.io web server over a secure connection and import
|
||||||
# it into your local GPG keychain (you'll need GPG installed). You only need to to do this
|
# it into your local GPG keychain (you'll need GPG installed). You only need to to do this
|
||||||
# once.
|
# once.
|
||||||
yarn run fetch --importkey
|
yarn run fetch --importkey
|
||||||
# Fetch the package and verify the signature
|
# Fetch the package and verify the signature
|
||||||
yarn run fetch --cfgdir ""
|
yarn run fetch --cfgdir ''
|
||||||
```
|
```
|
||||||
|
|
||||||
...or either of the above, but fetching a specific version of Element:
|
...or either of the above, but fetching a specific version of Element:
|
||||||
|
|
||||||
```
|
```
|
||||||
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version
|
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version
|
||||||
# fetched will be the same as the local element-desktop package.
|
# fetched will be the same as the local element-desktop package.
|
||||||
yarn run fetch --noverify --cfgdir "" v1.5.6
|
yarn run fetch --noverify --cfgdir '' v1.5.6
|
||||||
```
|
```
|
||||||
|
|
||||||
If you only want to run the app locally and don't need to build packages, you can
|
If you only want to run the app locally and don't need to build packages, you can
|
||||||
provide the `webapp` directory directly:
|
provide the `webapp` directory directly:
|
||||||
|
|
||||||
```
|
```
|
||||||
# Assuming you've checked out and built a copy of element-web in ../element-web
|
# Assuming you've checked out and built a copy of element-web in ../element-web
|
||||||
ln -s ../element-web/webapp ./
|
ln -s ../element-web/webapp ./
|
||||||
@ -58,68 +49,84 @@ ln -s ../element-web/webapp ./
|
|||||||
|
|
||||||
[TODO: add support for fetching develop builds, arbitrary URLs and arbitrary paths]
|
[TODO: add support for fetching develop builds, arbitrary URLs and arbitrary paths]
|
||||||
|
|
||||||
# Building
|
|
||||||
|
|
||||||
## Native Build
|
Building
|
||||||
|
========
|
||||||
|
Now you have a copy of Element, you're ready to build packages. If you'd just like to
|
||||||
|
run Element locally, skip to the next section.
|
||||||
|
|
||||||
TODO: List native pre-requisites
|
If you'd like to build the native modules (for searching in encrypted rooms and
|
||||||
|
secure storage), do this first. This will take 10 minutes or so, and will
|
||||||
|
require a number of native tools to be installed, depending on your OS (eg.
|
||||||
|
rust, tcl, make/nmake). If you don't need these features, you can skip this
|
||||||
|
step.
|
||||||
|
```
|
||||||
|
yarn run build:native
|
||||||
|
```
|
||||||
|
|
||||||
Optionally, [build the native modules](https://github.com/vector-im/element-desktop/blob/develop/docs/native-node-modules.md),
|
On Windows, this will automatically determine the architecture to build for based
|
||||||
which include support for searching in encrypted rooms and secure storage. Skipping this step is fine, you just won't have those features.
|
on the environment (ie. set up by vcvarsall.bat).
|
||||||
|
|
||||||
Then, run
|
Now you can build the package:
|
||||||
|
|
||||||
```
|
```
|
||||||
yarn run build
|
yarn run build
|
||||||
```
|
```
|
||||||
|
|
||||||
This will do a couple of things:
|
This will do a couple of things:
|
||||||
|
* Run the `setversion` script to set the local package version to match whatever
|
||||||
- Run the `setversion` script to set the local package version to match whatever
|
|
||||||
version of Element you installed above.
|
version of Element you installed above.
|
||||||
- Run electron-builder to build a package. The package built will match the operating system
|
* Run electron-builder to build a package. The package built will match the operating system
|
||||||
you're running the build process on.
|
you're running the build process on.
|
||||||
|
|
||||||
## Docker
|
If you're on Windows, you can choose to build specifically for 32 or 64 bit:
|
||||||
|
```
|
||||||
|
yarn run build32
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```
|
||||||
|
yarn run build64
|
||||||
|
```
|
||||||
|
|
||||||
Alternatively, you can also build using docker, which will always produce the linux package:
|
This build step will not build any native modules.
|
||||||
|
|
||||||
|
You can also build using docker, which will always produce the linux package:
|
||||||
```
|
```
|
||||||
# Run this once to make the docker image
|
# Run this once to make the docker image
|
||||||
yarn run docker:setup
|
yarn run docker:setup
|
||||||
|
|
||||||
yarn run docker:install
|
yarn run docker:install
|
||||||
# if you want to build the native modules (this will take a while)
|
# if you want to build the native modules (this will take a while)
|
||||||
yarn run docker:build:native
|
yarn run docker:buildnative
|
||||||
yarn run docker:build
|
yarn run docker:build
|
||||||
```
|
```
|
||||||
|
|
||||||
After running, the packages should be in `dist/`.
|
After running, the packages should be in `dist/`.
|
||||||
|
|
||||||
# Starting
|
Starting
|
||||||
|
========
|
||||||
If you'd just like to run the electron app locally for development:
|
If you'd just like to run the electron app locally for development:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
# Install electron - we don't normally need electron itself as it's provided
|
||||||
|
# by electron-builder when building packages
|
||||||
|
yarn add electron
|
||||||
yarn start
|
yarn start
|
||||||
```
|
```
|
||||||
|
|
||||||
# Config
|
Config
|
||||||
|
======
|
||||||
If you'd like the packaged Element to have a configuration file, you can create a
|
If you'd like the packaged Element to have a configuration file, you can create a
|
||||||
config directory and place `config.json` in there, then specify this directory
|
config directory and place `config.json` in there, then specify this directory
|
||||||
with the `--cfgdir` option to `yarn run fetch`, eg:
|
with the `--cfgdir` option to `yarn run fetch`, eg:
|
||||||
|
|
||||||
```
|
```
|
||||||
mkdir myconfig
|
mkdir myconfig
|
||||||
cp /path/to/my/config.json myconfig/
|
cp /path/to/my/config.json myconfig/
|
||||||
yarn run fetch --cfgdir myconfig
|
yarn run fetch --cfgdir myconfig
|
||||||
```
|
```
|
||||||
|
|
||||||
The config dir for the official Element app is in `element.io`. If you use this,
|
The config dir for the official Element app is in `element.io`. If you use this,
|
||||||
your app will auto-update itself using builds from element.io.
|
your app will auto-update itself using builds from element.io.
|
||||||
|
|
||||||
# Profiles
|
Profiles
|
||||||
|
========
|
||||||
|
|
||||||
To run multiple instances of the desktop app for different accounts, you can
|
To run multiple instances of the desktop app for different accounts, you can
|
||||||
launch the executable with the `--profile` argument followed by a unique
|
launch the executable with the `--profile` argument followed by a unique
|
||||||
@ -129,46 +136,21 @@ not interfere with the default one.
|
|||||||
Alternatively, a custom location for the profile data can be specified using the
|
Alternatively, a custom location for the profile data can be specified using the
|
||||||
`--profile-dir` flag followed by the desired path.
|
`--profile-dir` flag followed by the desired path.
|
||||||
|
|
||||||
# User-specified config.json
|
User-specified config.json
|
||||||
|
==========================
|
||||||
|
|
||||||
- `%APPDATA%\$NAME\config.json` on Windows
|
+ `%APPDATA%\$NAME\config.json` on Windows
|
||||||
- `$XDG_CONFIG_HOME/$NAME/config.json` or `~/.config/$NAME/config.json` on Linux
|
+ `$XDG_CONFIG_HOME\$NAME\config.json` or `~/.config/$NAME/config.json` on Linux
|
||||||
- `~/Library/Application Support/$NAME/config.json` on macOS
|
+ `~/Library/Application Support/$NAME/config.json` on macOS
|
||||||
|
|
||||||
In the paths above, `$NAME` is typically `Element`, unless you use `--profile
|
In the paths above, `$NAME` is typically `Element`, unless you use `--profile
|
||||||
$PROFILE` in which case it becomes `Element-$PROFILE`, or it is using one of
|
$PROFILE` in which case it becomes `Element-$PROFILE`, or it is using one of
|
||||||
the above created by a pre-1.7 install, in which case it will be `Riot` or
|
the above created by a pre-1.7 install, in which case it will be `Riot` or
|
||||||
`Riot-$PROFILE`.
|
`Riot-$PROFILE`.
|
||||||
|
|
||||||
You may also specify a different path entirely for the `config.json` file by
|
Report bugs & give feedback
|
||||||
providing the `--config $YOUR_CONFIG_JSON_FILE` to the process, or via the
|
==========================
|
||||||
`ELEMENT_DESKTOP_CONFIG_JSON` environment variable.
|
|
||||||
|
|
||||||
# Translations
|
|
||||||
|
|
||||||
To add a new translation, head to the [translating doc](https://github.com/vector-im/element-web/blob/develop/docs/translating.md).
|
|
||||||
|
|
||||||
For a developer guide, see the [translating dev doc](https://github.com/vector-im/element-web/blob/develop/docs/translating-dev.md).
|
|
||||||
|
|
||||||
# Report bugs & give feedback
|
|
||||||
|
|
||||||
If you run into any bugs or have feedback you'd like to share, please let us know on GitHub.
|
If you run into any bugs or have feedback you'd like to share, please let us know on GitHub.
|
||||||
|
|
||||||
To help avoid duplicate issues, please [view existing issues](https://github.com/vector-im/element-web/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc) first (and add a +1) or [create a new issue](https://github.com/vector-im/element-web/issues/new/choose) if you can't find it. Please note that this issue tracker is associated with the [element-web](https://github.com/vector-im/element-web) repo, but is also applied to the code in this repo as well.
|
To help avoid duplicate issues, please [view existing issues](https://github.com/vector-im/element-web/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc) first (and add a +1) or [create a new issue](https://github.com/vector-im/element-web/issues/new/choose) if you can't find it. Please note that this issue tracker is associated with the [element-web](https://github.com/vector-im/element-web) repo, but is also applied to the code in this repo as well.
|
||||||
|
|
||||||
## Copyright & License
|
|
||||||
|
|
||||||
Copyright (c) 2016-2017 OpenMarket Ltd
|
|
||||||
|
|
||||||
Copyright (c) 2017 Vector Creations Ltd
|
|
||||||
|
|
||||||
Copyright (c) 2017-2025 New Vector Ltd
|
|
||||||
|
|
||||||
This software is multi licensed by New Vector Ltd (Element). It can be used either:
|
|
||||||
|
|
||||||
(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
|
|
||||||
|
|
||||||
(2) for free 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); OR
|
|
||||||
|
|
||||||
(3) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
|
|
||||||
Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
|
|
||||||
|
|||||||
@ -1,3 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
presets: [["@babel/preset-env", { targets: { node: "current" } }], "@babel/preset-typescript"],
|
|
||||||
};
|
|
||||||
@ -9,11 +9,11 @@
|
|||||||
Latest electron-builder does, but it appears to be causing issues:
|
Latest electron-builder does, but it appears to be causing issues:
|
||||||
(https://github.com/electron-userland/electron-builder/issues/4390)
|
(https://github.com/electron-userland/electron-builder/issues/4390)
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<!-- https://github.com/electron/electron-notarize#prerequisites -->
|
<!-- https://github.com/electron/electron-notarize#prerequisites -->
|
||||||
<key>com.apple.security.cs.allow-jit</key>
|
<key>com.apple.security.cs.allow-jit</key>
|
||||||
<true/>
|
<true/>
|
||||||
|
<key>com.apple.security.cs.allow-unsigned-executable-memory</key>
|
||||||
|
<true/>
|
||||||
<!-- https://github.com/electron-userland/electron-builder/issues/3940 -->
|
<!-- https://github.com/electron-userland/electron-builder/issues/3940 -->
|
||||||
<key>com.apple.security.cs.disable-library-validation</key>
|
<key>com.apple.security.cs.disable-library-validation</key>
|
||||||
<true/>
|
<true/>
|
||||||
|
|||||||
51
build/rebrand_stub/rebrand_stub.c
Normal file
51
build/rebrand_stub/rebrand_stub.c
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
#include <windows.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <tchar.h>
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This just runs 'Element.exe' with the same args as
|
||||||
|
* this process was invoked with. This gets around the fact that
|
||||||
|
* squirrel always tries to run an executable with the same name,
|
||||||
|
* so fails to restart if the app's name has changed.
|
||||||
|
*/
|
||||||
|
void _tmain( int argc, TCHAR *argv[] )
|
||||||
|
{
|
||||||
|
LPSTR myCmdLine = GetCommandLineA();
|
||||||
|
char cmdLine[32767];
|
||||||
|
|
||||||
|
LPSTR cmdLinePos = cmdLine;
|
||||||
|
LPSTR toRun = "\"Element.exe\" ";
|
||||||
|
strncpy(cmdLinePos, toRun, strlen(toRun));
|
||||||
|
cmdLinePos += strlen(toRun);
|
||||||
|
|
||||||
|
if (myCmdLine[0] == '"') ++myCmdLine;
|
||||||
|
myCmdLine += strlen(argv[0]);
|
||||||
|
if (myCmdLine[0] == '"') ++myCmdLine;
|
||||||
|
if (myCmdLine[0] == ' ') ++myCmdLine;
|
||||||
|
|
||||||
|
strncpy(cmdLinePos, myCmdLine, (cmdLine + 32767) - cmdLinePos);
|
||||||
|
|
||||||
|
STARTUPINFO si;
|
||||||
|
PROCESS_INFORMATION pi;
|
||||||
|
|
||||||
|
ZeroMemory(&si, sizeof(si));
|
||||||
|
si.cb = sizeof(si);
|
||||||
|
ZeroMemory(&pi, sizeof(pi));
|
||||||
|
|
||||||
|
if (!CreateProcess(NULL,
|
||||||
|
cmdLine, // Command line
|
||||||
|
NULL, // Process handle not inheritable
|
||||||
|
NULL, // Thread handle not inheritable
|
||||||
|
FALSE, // Set handle inheritance to FALSE
|
||||||
|
0, // No creation flags
|
||||||
|
NULL, // Use parent's environment block
|
||||||
|
NULL, // Use parent's starting directory
|
||||||
|
&si, // Pointer to STARTUPINFO structure
|
||||||
|
&pi ) // Pointer to PROCESS_INFORMATION structure
|
||||||
|
)
|
||||||
|
{
|
||||||
|
printf("CreateProcess failed (%d).\n", GetLastError());
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
BIN
build/rebrand_stub/rebrand_stub.exe
Normal file
BIN
build/rebrand_stub/rebrand_stub.exe
Normal file
Binary file not shown.
@ -1,28 +1,45 @@
|
|||||||
# Docker image to facilitate building Element Desktop's native bits using a glibc version (2.31)
|
FROM buildpack-deps:xenial-curl
|
||||||
# with broader compatibility, down to Debian bullseye & Ubuntu focal.
|
|
||||||
FROM rust:bullseye
|
|
||||||
|
|
||||||
ENV DEBIAN_FRONTEND=noninteractive
|
ENV DEBIAN_FRONTEND noninteractive
|
||||||
|
|
||||||
RUN curl --proto "=https" -L https://yarnpkg.com/latest.tar.gz | tar xvz && mv yarn-* /yarn && ln -s /yarn/bin/yarn /usr/bin/yarn
|
RUN curl -L https://yarnpkg.com/latest.tar.gz | tar xvz && mv yarn-* /yarn && ln -s /yarn/bin/yarn /usr/bin/yarn
|
||||||
RUN apt-get -qq update && apt-get -y -qq dist-upgrade && \
|
RUN apt-get -qq update && apt-get -qq dist-upgrade && \
|
||||||
apt-get -y -qq install --no-install-recommends \
|
# add repo for git-lfs
|
||||||
# tclsh is required for building SQLite as part of SQLCipher
|
curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | bash && \
|
||||||
tcl \
|
# git ssh for using as docker image on CircleCI
|
||||||
# libsecret-1-dev is required even for prebuild keytar
|
# python for node-gyp
|
||||||
libsecret-1-dev \
|
# rpm is required for FPM to build rpm package
|
||||||
# Used by seshat (when not SQLCIPHER_STATIC) \
|
# libsecret-1-dev and libgnome-keyring-dev are required even for prebuild keytar
|
||||||
|
apt-get -qq install --no-install-recommends qtbase5-dev bsdtar build-essential autoconf libssl-dev gcc-multilib g++-multilib lzip rpm python libcurl3 git git-lfs ssh unzip \
|
||||||
|
libsecret-1-dev libgnome-keyring-dev \
|
||||||
|
libopenjp2-tools \
|
||||||
|
# Used by Seshat
|
||||||
libsqlcipher-dev && \
|
libsqlcipher-dev && \
|
||||||
|
# git-lfs
|
||||||
|
git lfs install && \
|
||||||
apt-get purge -y --auto-remove && rm -rf /var/lib/apt/lists/*
|
apt-get purge -y --auto-remove && rm -rf /var/lib/apt/lists/*
|
||||||
RUN dpkg --add-architecture i386 && apt-get update && apt-get install -y wine mono-devel rpm
|
|
||||||
RUN ln -s /usr/bin/python3 /usr/bin/python & ln -s /usr/bin/pip3 /usr/bin/pip
|
|
||||||
|
|
||||||
ENV DEBUG_COLORS=true
|
|
||||||
ENV FORCE_COLOR=true
|
|
||||||
|
|
||||||
WORKDIR /project
|
WORKDIR /project
|
||||||
|
|
||||||
ARG TARGETOS
|
# fix error /usr/local/bundle/gems/fpm-1.5.0/lib/fpm/package/freebsd.rb:72:in `encode': "\xE2" from ASCII-8BIT to UTF-8 (Encoding::UndefinedConversionError)
|
||||||
ARG TARGETARCH
|
# http://jaredmarkell.com/docker-and-locales/
|
||||||
COPY .node-version dockerbuild/setup.sh /
|
# http://askubuntu.com/a/601498
|
||||||
RUN /setup.sh
|
ENV LANG C.UTF-8
|
||||||
|
ENV LANGUAGE C.UTF-8
|
||||||
|
ENV LC_ALL C.UTF-8
|
||||||
|
|
||||||
|
ENV DEBUG_COLORS true
|
||||||
|
ENV FORCE_COLOR true
|
||||||
|
ENV NODE_VERSION 12.16.1
|
||||||
|
|
||||||
|
# this package is used for snapcraft and we should not clear apt list - to avoid apt-get update during snap build
|
||||||
|
RUN curl -L https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.gz | tar xz -C /usr/local --strip-components=1 && \
|
||||||
|
unlink /usr/local/CHANGELOG.md && unlink /usr/local/LICENSE && unlink /usr/local/README.md && \
|
||||||
|
# https://github.com/npm/npm/issues/4531
|
||||||
|
npm config set unsafe-perm true
|
||||||
|
|
||||||
|
ENV RUSTUP_HOME=/usr/local/rustup \
|
||||||
|
CARGO_HOME=/usr/local/cargo \
|
||||||
|
PATH=/usr/local/cargo/bin:$PATH
|
||||||
|
|
||||||
|
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --no-modify-path --profile minimal
|
||||||
|
|||||||
@ -1,8 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
set -x
|
|
||||||
declare -A archMap=(["amd64"]="x64" ["arm64"]="arm64")
|
|
||||||
ARCH="${archMap["$TARGETARCH"]}"
|
|
||||||
NODE_VERSION=$(cat /.node-version)
|
|
||||||
curl --proto "=https" -L "https://nodejs.org/dist/$NODE_VERSION/node-$NODE_VERSION-$TARGETOS-$ARCH.tar.gz" | tar xz -C /usr/local --strip-components=1 && \
|
|
||||||
unlink /usr/local/CHANGELOG.md && unlink /usr/local/LICENSE && unlink /usr/local/README.md
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# Summary
|
|
||||||
|
|
||||||
- [Introduction](../README.md)
|
|
||||||
|
|
||||||
# Build
|
|
||||||
|
|
||||||
- [Native Node modules](native-node-modules.md)
|
|
||||||
- [Windows requirements](windows-requirements.md)
|
|
||||||
|
|
||||||
# Distribution
|
|
||||||
|
|
||||||
- [Updates](updates.md)
|
|
||||||
- [Packaging](packaging.md)
|
|
||||||
|
|
||||||
# Setup
|
|
||||||
|
|
||||||
- [Config](config.md)
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
# Configuration
|
|
||||||
|
|
||||||
All Element Web options documented [here](https://github.com/vector-im/element-web/blob/develop/docs/config.md) can be used as well as the following:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
The app contains a configuration file specified at build time using [these instructions](https://github.com/vector-im/element-desktop/#config).
|
|
||||||
This config can be overwritten by the end using by creating a `config.json` file at the paths described [here](https://github.com/vector-im/element-desktop/#user-specified-configjson).
|
|
||||||
|
|
||||||
After changing the config, the app will need to be exited fully (including via the task tray) and re-started.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
1. `update_base_url`: Specifies the URL of the update server, see [document](https://github.com/vector-im/element-desktop/blob/develop/docs/updates.md).
|
|
||||||
2. `web_base_url`: Specifies the Element Web URL when performing actions such as popout widget. Defaults to `https://app.element.io/`.
|
|
||||||
@ -1,157 +0,0 @@
|
|||||||
# Native Node Modules
|
|
||||||
|
|
||||||
For some features, the desktop version of Element can make use of native Node
|
|
||||||
modules. These allow Element to integrate with the desktop in ways that a browser
|
|
||||||
cannot.
|
|
||||||
|
|
||||||
While native modules enable powerful new features, they must be complied for
|
|
||||||
each operating system. For official Element releases, we will always build these
|
|
||||||
modules from source to ensure we can trust the compiled output. In the future,
|
|
||||||
we may offer a pre-compiled path for those who want to use these features in a
|
|
||||||
custom build of Element without installing the various build tools required.
|
|
||||||
|
|
||||||
The process is automated by [vector-im/element-builder](https://github.com/vector-im/element-builder)
|
|
||||||
when releasing.
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
Install the pre-requisites for your system:
|
|
||||||
|
|
||||||
- [Windows pre-requisites](https://github.com/vector-im/element-desktop/blob/develop/docs/windows-requirements.md)
|
|
||||||
- Linux: TODO
|
|
||||||
- OS X: TODO
|
|
||||||
|
|
||||||
Then optionally, [add seshat and dependencies to support search in E2E rooms](#adding-seshat-for-search-in-e2e-encrypted-rooms).
|
|
||||||
|
|
||||||
Then, to build for an architecture selected automatically based on your system (recommended), run:
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:native
|
|
||||||
```
|
|
||||||
|
|
||||||
If you need to build for a specific architecture, see [here](#compiling-for-specific-architectures).
|
|
||||||
|
|
||||||
## Adding Seshat for search in E2E encrypted rooms
|
|
||||||
|
|
||||||
Seshat is a native Node module that adds support for local event indexing and
|
|
||||||
full text search in E2E encrypted rooms.
|
|
||||||
|
|
||||||
Since Seshat is written in Rust, the Rust compiler and related tools need to be
|
|
||||||
installed before installing Seshat itself. To install Rust please consult the
|
|
||||||
official Rust [documentation](https://www.rust-lang.org/tools/install).
|
|
||||||
|
|
||||||
Seshat also depends on the SQLCipher library to store its data in encrypted form
|
|
||||||
on disk. You'll need to install it via your OS package manager.
|
|
||||||
|
|
||||||
After installing the Rust compiler and SQLCipher, Seshat support can be added
|
|
||||||
using yarn at the root of this project:
|
|
||||||
|
|
||||||
yarn add matrix-seshat
|
|
||||||
|
|
||||||
You will have to rebuild the native libraries against electron's version
|
|
||||||
of node rather than your system node, using the `electron-build-env` tool.
|
|
||||||
This is also needed to when pulling in changes to Seshat using `yarn link`.
|
|
||||||
|
|
||||||
yarn add electron-build-env
|
|
||||||
|
|
||||||
Recompiling Seshat itself can be done like so:
|
|
||||||
|
|
||||||
yarn run electron-build-env -- --electron 6.1.1 -- neon build matrix-seshat --release
|
|
||||||
|
|
||||||
Please make sure to include all the `--` as well as the `--release` command line
|
|
||||||
switch at the end. Modify your electron version accordingly depending on the
|
|
||||||
version that is installed on your system.
|
|
||||||
|
|
||||||
After this is done the Electron version of Element can be run from the main folder
|
|
||||||
as usual using:
|
|
||||||
|
|
||||||
yarn start
|
|
||||||
|
|
||||||
### Statically linking libsqlcipher
|
|
||||||
|
|
||||||
On Windows & macOS we always statically link libsqlcipher for it is not generally available.
|
|
||||||
On Linux by default we will use a system package, on debian & ubuntu this is `libsqlcipher0`,
|
|
||||||
but this is problematic for some other packages, and we found that it may crashes for unknown reasons.
|
|
||||||
By including `SQLCIPHER_BUNDLED=1` in the build environment, the build scripts will fully statically
|
|
||||||
link sqlcipher, including a static build of OpenSSL.
|
|
||||||
|
|
||||||
More info can be found at https://github.com/matrix-org/seshat/issues/102
|
|
||||||
and https://github.com/vector-im/element-web/issues/20926.
|
|
||||||
|
|
||||||
## Compiling for specific architectures
|
|
||||||
|
|
||||||
### macOS
|
|
||||||
|
|
||||||
On macOS, you can build universal native modules too:
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:native:universal
|
|
||||||
```
|
|
||||||
|
|
||||||
...or you can build for a specific architecture:
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:native --target x86_64-apple-darwin
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:native --target aarch64-apple-darwin
|
|
||||||
```
|
|
||||||
|
|
||||||
You'll then need to create a built bundle with the same architecture.
|
|
||||||
To bundle a universal build for macOS, run:
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:universal
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows
|
|
||||||
|
|
||||||
If you're on Windows, you can choose to build specifically for 32 or 64 bit:
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:32
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:64
|
|
||||||
```
|
|
||||||
|
|
||||||
### Cross compiling
|
|
||||||
|
|
||||||
Compiling a module for a particular operating system (Linux/macOS/Windows) needs
|
|
||||||
to be done on that operating system. Cross-compiling from a host OS for a different
|
|
||||||
target OS may be possible, but we don't support this flow with Element dependencies
|
|
||||||
at this time.
|
|
||||||
|
|
||||||
### Switching between architectures
|
|
||||||
|
|
||||||
The native module build system keeps the different architectures
|
|
||||||
separate, so you can keep native modules for several architectures at the same
|
|
||||||
time and switch which are active using a `yarn run hak copy` command, passing
|
|
||||||
the appropriate architectures. This will error if you haven't yet built those
|
|
||||||
architectures. eg:
|
|
||||||
|
|
||||||
```
|
|
||||||
yarn run build:native --target x86_64-apple-darwin
|
|
||||||
# We've now built & linked into place native modules for Intel
|
|
||||||
yarn run build:native --target aarch64-apple-darwin
|
|
||||||
# We've now built Apple Silicon modules too, and linked them into place as the active ones
|
|
||||||
|
|
||||||
yarn run hak copy --target x86_64-apple-darwin
|
|
||||||
# We've now switched back to our Intel modules
|
|
||||||
yarn run hak copy --target x86_64-apple-darwin --target aarch64-apple-darwin
|
|
||||||
# Now our native modules are universal x86_64+aarch64 binaries
|
|
||||||
```
|
|
||||||
|
|
||||||
The current set of native modules are stored in `.hak/hakModules`,
|
|
||||||
so you can use this to check what architecture is currently in place, eg:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ lipo -info .hak/hakModules/keytar/build/Release/keytar.node
|
|
||||||
Architectures in the fat file: .hak/hakModules/keytar/build/Release/keytar.node are: x86_64 arm64
|
|
||||||
```
|
|
||||||
@ -1,55 +0,0 @@
|
|||||||
## Packaging nightlies
|
|
||||||
|
|
||||||
Element Desktop nightly builds are build automatically by the [Github Actions workflow](https://github.com/vector-im/element-desktop/blob/develop/.github/workflows/build_and_deploy.yaml).
|
|
||||||
The schedule is currently set for once a day at 9am UTC. It will deploy to packages.element.io upon completion.
|
|
||||||
|
|
||||||
## Triggering a manual nightly build
|
|
||||||
|
|
||||||
Simply go to https://github.com/vector-im/element-desktop/actions/workflows/build_and_deploy.yaml
|
|
||||||
|
|
||||||
1. Click `Run workflow`
|
|
||||||
1. Feel free to make changes to the checkboxes depending on the circumstances
|
|
||||||
1. Click the green `Run workflow`
|
|
||||||
|
|
||||||
## Packaging releases
|
|
||||||
|
|
||||||
**Don't do this for RCs! We don't build Element Desktop for RCs.**
|
|
||||||
|
|
||||||
For releasing Element Desktop, we assume the following prerequisites:
|
|
||||||
|
|
||||||
- a tag of `element-desktop` repo with the Element Desktop version to be released set in `package.json`.
|
|
||||||
- an Element Web tarball published to GitHub with a matching version number.
|
|
||||||
|
|
||||||
**Both of these are done automatically when you run the release automation.**
|
|
||||||
|
|
||||||
The packaging is kicked off automagically for you when a Github Release for Element Desktop is published.
|
|
||||||
|
|
||||||
### More detail on the github actions
|
|
||||||
|
|
||||||
We moved to Github Actions for the following reasons:
|
|
||||||
|
|
||||||
1. Removing single point of failure
|
|
||||||
2. Improving reliability
|
|
||||||
3. Unblocking the packaging on a single individual
|
|
||||||
4. Improving parallelism
|
|
||||||
|
|
||||||
The Windows builds are signed by SSL.com using their Cloud Key Adapter for eSigner.
|
|
||||||
This allows us to use Microsoft's signtool to interface with eSigner and send them a hash of the exe along with
|
|
||||||
credentials in exchange for a signed certificate which we attach onto all the relevant files.
|
|
||||||
|
|
||||||
The Apple builds are signed using standard code signing means and then notarised to appease GateKeeper.
|
|
||||||
|
|
||||||
The Linux builds are distributed via a signed reprepro repository.
|
|
||||||
|
|
||||||
The packages.element.io site is a public Cloudflare R2 bucket which is deployed to solely from Github Actions.
|
|
||||||
The main bucket in R2 is `packages-element-io` which is a direct mapping of packages.element.io,
|
|
||||||
we have a workflow which generates the index.html files there to imitate a public index which Cloudflare does not currently support.
|
|
||||||
The reprepro database lives in `packages-element-io-db`.
|
|
||||||
There is an additional pair of buckets of same name but appended with `-test` which can be used for testing,
|
|
||||||
these land on https://packages-element-io-test.element.io/.
|
|
||||||
|
|
||||||
### Debian/Ubuntu Distributions
|
|
||||||
|
|
||||||
We used to add a new distribution to match each Debian and Ubuntu release. As of April 2020, we have created a `default` distribution that everyone can use (since the packages have never differed by distribution anyway).
|
|
||||||
|
|
||||||
The distribution configuration lives in https://github.com/vector-im/packages.element.io/blob/master/debian/conf/distributions as a canonical source.
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
The Desktop app is capable of self-updating on macOS and Windows.
|
|
||||||
The update server base url is configurable as `update_base_url` in config.json and can be served by a static file host,
|
|
||||||
CDN or object storage.
|
|
||||||
|
|
||||||
Currently all packaging & deployment is handled by [Github actions](https://github.com/vector-im/element-desktop/blob/develop/.github/workflows/build_and_deploy.yaml)
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
|
|
||||||
On Windows the update mechanism used is [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows)
|
|
||||||
and can be served by any compatible Squirrel server, such as https://github.com/Tiliq/squirrel-server
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
|
|
||||||
On macOS the update mechanism used is [Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac)
|
|
||||||
using the newer JSON format as documented [here](https://github.com/Squirrel/Squirrel.Mac#update-file-json-format).
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
# Windows
|
|
||||||
|
|
||||||
## Requirements to build native modules
|
|
||||||
|
|
||||||
We rely on Github Actions `windows-2022` plus a few extra utilities as per [the workflow](https://github.com/vector-im/element-desktop/blob/develop/.github/workflows/build_windows.yaml).
|
|
||||||
|
|
||||||
If you want to build native modules, make sure that the following tools are installed on your system.
|
|
||||||
|
|
||||||
- [Git for Windows](https://git-scm.com/download/win)
|
|
||||||
- [Node 16](https://nodejs.org)
|
|
||||||
- [Python 3](https://www.python.org/downloads/) (if you type 'python' into command prompt it will offer to install it from the windows store)
|
|
||||||
- [Strawberry Perl](https://strawberryperl.com/)
|
|
||||||
- [Rustup](https://rustup.rs/)
|
|
||||||
- [NASM](https://www.nasm.us/)
|
|
||||||
|
|
||||||
You can install the above tools using [Chocolatey](https://chocolatey.org/install):
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
choco install --no-progress -y git nodejs-lts yarn python StrawberryPerl rustup.install nasm magicsplat-tcl-tk
|
|
||||||
```
|
|
||||||
|
|
||||||
- [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) with the following configuration:
|
|
||||||
- On the Workloads tab:
|
|
||||||
- Desktop & Mobile -> C++ build tools
|
|
||||||
- On the Individual components tab:
|
|
||||||
- MSVC VS 2019 C++ build tools
|
|
||||||
- Windows 10 SDK (latest version available)
|
|
||||||
- C++ CMake tools for Windows
|
|
||||||
|
|
||||||
Once installed make sure all those utilities are accessible in your `PATH`.
|
|
||||||
|
|
||||||
If you want to be able to build x86 targets from an x64 host install the right toolchain:
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
rustup toolchain install stable-i686-pc-windows-msvc
|
|
||||||
rustup target add i686-pc-windows-msvc
|
|
||||||
```
|
|
||||||
|
|
||||||
In order to load all the C++ utilities installed by Visual Studio you can run the following in a terminal window.
|
|
||||||
|
|
||||||
```
|
|
||||||
call "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvarsall.bat" amd64
|
|
||||||
```
|
|
||||||
|
|
||||||
You can replace `amd64` with `x86` depending on your CPU architecture.
|
|
||||||
@ -1,236 +0,0 @@
|
|||||||
import * as os from "node:os";
|
|
||||||
import * as fs from "node:fs";
|
|
||||||
import * as path from "node:path";
|
|
||||||
import * as plist from "plist";
|
|
||||||
import { AfterPackContext, Arch, Configuration as BaseConfiguration, Platform } from "electron-builder";
|
|
||||||
import { computeData } from "app-builder-lib/out/asar/integrity";
|
|
||||||
import { readFile, writeFile } from "node:fs/promises";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This script has different outputs depending on your os platform.
|
|
||||||
*
|
|
||||||
* On Windows:
|
|
||||||
* Prefixes the nightly version with `0.0.1-nightly.` as it breaks if it is not semver
|
|
||||||
* Passes $ED_SIGNTOOL_THUMBPRINT and $ED_SIGNTOOL_SUBJECT_NAME to
|
|
||||||
* build.win.signtoolOptions.signingHashAlgorithms and build.win.signtoolOptions.certificateSubjectName respectively if specified.
|
|
||||||
*
|
|
||||||
* On Linux:
|
|
||||||
* Replaces spaces in the product name with dashes as spaces in paths can cause issues
|
|
||||||
* Removes libsqlcipher0 recommended dependency if env SQLCIPHER_BUNDLED is asserted.
|
|
||||||
* Passes $ED_DEBIAN_CHANGELOG to build.deb.fpm if specified
|
|
||||||
*/
|
|
||||||
|
|
||||||
const NIGHTLY_APP_ID = "im.riot.nightly";
|
|
||||||
const NIGHTLY_DEB_NAME = "element-nightly";
|
|
||||||
|
|
||||||
interface Pkg {
|
|
||||||
name: string;
|
|
||||||
productName: string;
|
|
||||||
description: string;
|
|
||||||
version: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
type Writable<T> = NonNullable<
|
|
||||||
T extends Function ? T : T extends object ? { -readonly [K in keyof T]: Writable<T[K]> } : T
|
|
||||||
>;
|
|
||||||
|
|
||||||
const pkg: Pkg = JSON.parse(fs.readFileSync("package.json", "utf8"));
|
|
||||||
|
|
||||||
interface Configuration extends BaseConfiguration {
|
|
||||||
extraMetadata: Partial<Pick<Pkg, "version">> & Omit<Pkg, "version">;
|
|
||||||
linux: BaseConfiguration["linux"];
|
|
||||||
win: BaseConfiguration["win"];
|
|
||||||
mac: BaseConfiguration["mac"];
|
|
||||||
deb: {
|
|
||||||
fpm: string[];
|
|
||||||
} & BaseConfiguration["deb"];
|
|
||||||
}
|
|
||||||
|
|
||||||
async function injectAsarIntegrity(context: AfterPackContext) {
|
|
||||||
const packager = context.packager;
|
|
||||||
|
|
||||||
// We only need to re-generate asar on universal Mac builds, due to https://github.com/electron/universal/issues/116
|
|
||||||
if (packager.platform !== Platform.MAC || context.arch !== Arch.universal) return;
|
|
||||||
|
|
||||||
const resourcesPath = packager.getResourcesDir(context.appOutDir);
|
|
||||||
const asarIntegrity = await computeData({
|
|
||||||
resourcesPath,
|
|
||||||
resourcesRelativePath: "Resources",
|
|
||||||
resourcesDestinationPath: resourcesPath,
|
|
||||||
extraResourceMatchers: [],
|
|
||||||
});
|
|
||||||
|
|
||||||
const plistPath = path.join(resourcesPath, "..", "Info.plist");
|
|
||||||
const data = plist.parse(await readFile(plistPath, "utf8")) as unknown as Writable<plist.PlistObject>;
|
|
||||||
data["ElectronAsarIntegrity"] = asarIntegrity as unknown as Writable<plist.PlistValue>;
|
|
||||||
await writeFile(plistPath, plist.build(data));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @type {import('electron-builder').Configuration}
|
|
||||||
* @see https://www.electron.build/configuration/configuration
|
|
||||||
*/
|
|
||||||
const config: Omit<Writable<Configuration>, "electronFuses"> & {
|
|
||||||
// Make all fuses required to ensure they are all explicitly specified
|
|
||||||
electronFuses: Required<Configuration["electronFuses"]>;
|
|
||||||
} = {
|
|
||||||
appId: "im.riot.app",
|
|
||||||
asarUnpack: "**/*.node",
|
|
||||||
electronFuses: {
|
|
||||||
enableCookieEncryption: true,
|
|
||||||
onlyLoadAppFromAsar: true,
|
|
||||||
grantFileProtocolExtraPrivileges: false,
|
|
||||||
|
|
||||||
runAsNode: false,
|
|
||||||
enableNodeOptionsEnvironmentVariable: false,
|
|
||||||
enableNodeCliInspectArguments: false,
|
|
||||||
// We need to reset the signature if we are not signing on darwin otherwise it won't launch
|
|
||||||
resetAdHocDarwinSignature: !process.env.APPLE_TEAM_ID,
|
|
||||||
|
|
||||||
loadBrowserProcessSpecificV8Snapshot: false,
|
|
||||||
enableEmbeddedAsarIntegrityValidation: true,
|
|
||||||
},
|
|
||||||
afterPack: async (context: AfterPackContext) => {
|
|
||||||
await injectAsarIntegrity(context);
|
|
||||||
},
|
|
||||||
files: [
|
|
||||||
"package.json",
|
|
||||||
{
|
|
||||||
from: ".hak/hakModules",
|
|
||||||
to: "node_modules",
|
|
||||||
},
|
|
||||||
"lib/**",
|
|
||||||
],
|
|
||||||
extraResources: [
|
|
||||||
{
|
|
||||||
from: "res/img",
|
|
||||||
to: "img",
|
|
||||||
},
|
|
||||||
"webapp.asar",
|
|
||||||
],
|
|
||||||
extraMetadata: {
|
|
||||||
name: pkg.name,
|
|
||||||
productName: pkg.productName,
|
|
||||||
description: pkg.description,
|
|
||||||
},
|
|
||||||
linux: {
|
|
||||||
target: ["tar.gz", "deb"],
|
|
||||||
category: "Network;InstantMessaging;Chat",
|
|
||||||
maintainer: "support@element.io",
|
|
||||||
icon: "build/icons",
|
|
||||||
},
|
|
||||||
deb: {
|
|
||||||
packageCategory: "net",
|
|
||||||
depends: [
|
|
||||||
"libgtk-3-0",
|
|
||||||
"libnotify4",
|
|
||||||
"libnss3",
|
|
||||||
"libxss1",
|
|
||||||
"libxtst6",
|
|
||||||
"xdg-utils",
|
|
||||||
"libatspi2.0-0",
|
|
||||||
"libuuid1",
|
|
||||||
"libsecret-1-0",
|
|
||||||
"libasound2",
|
|
||||||
"libgbm1",
|
|
||||||
],
|
|
||||||
recommends: ["libsqlcipher0", "element-io-archive-keyring"],
|
|
||||||
fpm: [
|
|
||||||
"--deb-field",
|
|
||||||
"Replaces: riot-desktop (<< 1.7.0), riot-web (<< 1.7.0)",
|
|
||||||
"--deb-field",
|
|
||||||
"Breaks: riot-desktop (<< 1.7.0), riot-web (<< 1.7.0)",
|
|
||||||
"--deb-pre-depends",
|
|
||||||
"libc6 (>= 2.31)",
|
|
||||||
],
|
|
||||||
},
|
|
||||||
mac: {
|
|
||||||
category: "public.app-category.social-networking",
|
|
||||||
darkModeSupport: true,
|
|
||||||
hardenedRuntime: true,
|
|
||||||
gatekeeperAssess: true,
|
|
||||||
// XXX: we cannot specify this due to https://github.com/electron/osx-sign/issues/344
|
|
||||||
// strictVerify: true,
|
|
||||||
entitlements: "./build/entitlements.mac.plist",
|
|
||||||
icon: "build/icons/icon.icns",
|
|
||||||
mergeASARs: true,
|
|
||||||
},
|
|
||||||
win: {
|
|
||||||
target: ["squirrel", "msi"],
|
|
||||||
signtoolOptions: {
|
|
||||||
signingHashAlgorithms: ["sha256"],
|
|
||||||
},
|
|
||||||
icon: "build/icons/icon.ico",
|
|
||||||
},
|
|
||||||
msi: {
|
|
||||||
perMachine: true,
|
|
||||||
},
|
|
||||||
directories: {
|
|
||||||
output: "dist",
|
|
||||||
},
|
|
||||||
protocols: [
|
|
||||||
{
|
|
||||||
name: "element",
|
|
||||||
schemes: ["io.element.desktop", "element"],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
nativeRebuilder: "sequential",
|
|
||||||
nodeGypRebuild: false,
|
|
||||||
npmRebuild: true,
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Allow specifying windows signing cert via env vars
|
|
||||||
* @param {string} process.env.ED_SIGNTOOL_SUBJECT_NAME
|
|
||||||
* @param {string} process.env.ED_SIGNTOOL_THUMBPRINT
|
|
||||||
*/
|
|
||||||
if (process.env.ED_SIGNTOOL_SUBJECT_NAME && process.env.ED_SIGNTOOL_THUMBPRINT) {
|
|
||||||
config.win.signtoolOptions!.certificateSubjectName = process.env.ED_SIGNTOOL_SUBJECT_NAME;
|
|
||||||
config.win.signtoolOptions!.certificateSha1 = process.env.ED_SIGNTOOL_THUMBPRINT;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Allow specifying nightly version via env var
|
|
||||||
* @param {string} process.env.ED_NIGHTLY
|
|
||||||
*/
|
|
||||||
if (process.env.ED_NIGHTLY) {
|
|
||||||
config.deb.fpm = []; // Clear the fpm as the breaks deb fields don't apply to nightly
|
|
||||||
|
|
||||||
config.appId = NIGHTLY_APP_ID;
|
|
||||||
config.extraMetadata.productName += " Nightly";
|
|
||||||
config.extraMetadata.name += "-nightly";
|
|
||||||
config.extraMetadata.description += " (nightly unstable build)";
|
|
||||||
config.deb.fpm.push("--name", NIGHTLY_DEB_NAME);
|
|
||||||
|
|
||||||
let version = process.env.ED_NIGHTLY;
|
|
||||||
if (os.platform() === "win32") {
|
|
||||||
// The windows packager relies on parsing this as semver, so we have to make it look like one.
|
|
||||||
// This will give our update packages really stupid names, but we probably can't change that either
|
|
||||||
// because squirrel windows parses them for the version too. We don't really care: nobody sees them.
|
|
||||||
// We just give the installer a static name, so you'll just see this in the 'about' dialog.
|
|
||||||
// Turns out if you use 0.0.0 here it makes Squirrel windows crash, so we use 0.0.1.
|
|
||||||
version = "0.0.1-nightly." + version;
|
|
||||||
}
|
|
||||||
config.extraMetadata.version = version;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (os.platform() === "linux") {
|
|
||||||
// Electron crashes on debian if there's a space in the path.
|
|
||||||
// https://github.com/vector-im/element-web/issues/13171
|
|
||||||
config.extraMetadata.productName = config.extraMetadata.productName.replace(/ /g, "-");
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Allow specifying deb changelog via env var
|
|
||||||
* @param {string} process.env.ED_DEB_CHANGELOG
|
|
||||||
*/
|
|
||||||
if (process.env.ED_DEBIAN_CHANGELOG) {
|
|
||||||
config.deb.fpm.push(`--deb-changelog=${process.env.ED_DEBIAN_CHANGELOG}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (process.env.SQLCIPHER_BUNDLED) {
|
|
||||||
// Remove sqlcipher dependency when using bundled
|
|
||||||
config.deb.recommends = config.deb.recommends?.filter((d) => d !== "libsqlcipher0");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export default config;
|
|
||||||
@ -1,17 +1,9 @@
|
|||||||
{
|
{
|
||||||
"update_base_url": "https://packages.element.io/nightly/update/",
|
"update_base_url": "https://packages.riot.im/nightly/update/",
|
||||||
"default_server_name": "matrix.org",
|
"default_server_name": "matrix.org",
|
||||||
"default_server_config": {
|
|
||||||
"m.homeserver": {
|
|
||||||
"base_url": "https://matrix-client.matrix.org"
|
|
||||||
},
|
|
||||||
"m.identity_server": {
|
|
||||||
"base_url": "https://vector.im"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"brand": "Element Nightly",
|
"brand": "Element Nightly",
|
||||||
"integrations_ui_url": "https://scalar.vector.im/",
|
"integrations_ui_url": "https://scalar-staging.vector.im/",
|
||||||
"integrations_rest_url": "https://scalar.vector.im/api",
|
"integrations_rest_url": "https://scalar-staging.vector.im/api",
|
||||||
"integrations_widgets_urls": [
|
"integrations_widgets_urls": [
|
||||||
"https://scalar.vector.im/_matrix/integrations/v1",
|
"https://scalar.vector.im/_matrix/integrations/v1",
|
||||||
"https://scalar.vector.im/api",
|
"https://scalar.vector.im/api",
|
||||||
@ -19,11 +11,19 @@
|
|||||||
"https://scalar-staging.vector.im/api",
|
"https://scalar-staging.vector.im/api",
|
||||||
"https://scalar-staging.riot.im/scalar/api"
|
"https://scalar-staging.riot.im/scalar/api"
|
||||||
],
|
],
|
||||||
|
"hosting_signup_link": "https://element.io/matrix-services?utm_source=element-web&utm_medium=web",
|
||||||
"bug_report_endpoint_url": "https://element.io/bugreports/submit",
|
"bug_report_endpoint_url": "https://element.io/bugreports/submit",
|
||||||
"uisi_autorageshake_app": "element-auto-uisi",
|
"showLabsSettings": true,
|
||||||
"show_labs_settings": true,
|
"piwik": {
|
||||||
"room_directory": {
|
"url": "https://piwik.riot.im/",
|
||||||
"servers": ["matrix.org", "gitter.im"]
|
"siteId": 1,
|
||||||
|
"policyUrl": "https://element.io/cookie-policy"
|
||||||
|
},
|
||||||
|
"roomDirectory": {
|
||||||
|
"servers": [
|
||||||
|
"matrix.org",
|
||||||
|
"gitter.im"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"enable_presence_by_hs_url": {
|
"enable_presence_by_hs_url": {
|
||||||
"https://matrix.org": false,
|
"https://matrix.org": false,
|
||||||
@ -38,28 +38,5 @@
|
|||||||
"url": "https://element.io/cookie-policy",
|
"url": "https://element.io/cookie-policy",
|
||||||
"text": "Cookie Policy"
|
"text": "Cookie Policy"
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"sentry": {
|
|
||||||
"dsn": "https://029a0eb289f942508ae0fb17935bd8c5@sentry.matrix.org/6",
|
|
||||||
"environment": "nightly"
|
|
||||||
},
|
|
||||||
"posthog": {
|
|
||||||
"project_api_key": "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO",
|
|
||||||
"api_host": "https://posthog.element.io"
|
|
||||||
},
|
|
||||||
"privacy_policy_url": "https://element.io/cookie-policy",
|
|
||||||
"features": {
|
|
||||||
"threadsActivityCentre": true,
|
|
||||||
"feature_spotlight": true,
|
|
||||||
"feature_group_calls": true,
|
|
||||||
"feature_video_rooms": true,
|
|
||||||
"feature_element_call_video_rooms": true
|
|
||||||
},
|
|
||||||
"setting_defaults": {
|
|
||||||
"RustCrypto.staged_rollout_percent": 100
|
|
||||||
},
|
|
||||||
"element_call": {
|
|
||||||
"url": "https://call.element.dev"
|
|
||||||
},
|
|
||||||
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"
|
|
||||||
}
|
}
|
||||||
|
|||||||
11
element.io/nightly/control.template
Normal file
11
element.io/nightly/control.template
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
Package: element-nightly
|
||||||
|
License: Apache-2.0
|
||||||
|
Vendor: support@element.io
|
||||||
|
Architecture: amd64
|
||||||
|
Maintainer: support@element.io
|
||||||
|
Depends: libgtk-3-0, libnotify4, libnss3, libxss1, libxtst6, xdg-utils, libatspi2.0-0, libuuid1, libappindicator3-1, libsecret-1-0, libsqlcipher0
|
||||||
|
Section: net
|
||||||
|
Priority: extra
|
||||||
|
Homepage: https://element.io/
|
||||||
|
Description:
|
||||||
|
riot.im A feature-rich client for Matrix.org (nightly unstable build).
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
Package: riot-nightly
|
||||||
|
Version: 2020071502
|
||||||
|
Depends: element-nightly
|
||||||
|
Maintainer: packages@element.io
|
||||||
|
Architecture: all
|
||||||
|
Priority: optional
|
||||||
|
Section: oldlibs
|
||||||
|
Description: transitional package
|
||||||
|
This is a transitional package. It can safely be removed.
|
||||||
81
element.io/release/conf_distributions
Normal file
81
element.io/release/conf_distributions
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
Origin: riot.im
|
||||||
|
Codename: default
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Suite: oldoldstable
|
||||||
|
Codename: jessie
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Suite: oldstable
|
||||||
|
Codename: stretch
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Suite: stable
|
||||||
|
Codename: buster
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Suite: testing
|
||||||
|
Codename: bullseye
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Suite: unstable
|
||||||
|
Codename: sid
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Codename: xenial
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Codename: bionic
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Codename: cosmic
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Codename: disco
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
|
|
||||||
|
Origin: riot.im
|
||||||
|
Codename: eoan
|
||||||
|
Architectures: amd64 i386 source
|
||||||
|
Components: main
|
||||||
|
SignWith: D7B0B66941D01538
|
||||||
|
Tracking: minimal
|
||||||
@ -1,14 +1,6 @@
|
|||||||
{
|
{
|
||||||
"update_base_url": "https://packages.element.io/desktop/update/",
|
"update_base_url": "https://packages.riot.im/desktop/update/",
|
||||||
"default_server_name": "matrix.org",
|
"default_server_name": "matrix.org",
|
||||||
"default_server_config": {
|
|
||||||
"m.homeserver": {
|
|
||||||
"base_url": "https://matrix-client.matrix.org"
|
|
||||||
},
|
|
||||||
"m.identity_server": {
|
|
||||||
"base_url": "https://vector.im"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"brand": "Element",
|
"brand": "Element",
|
||||||
"integrations_ui_url": "https://scalar.vector.im/",
|
"integrations_ui_url": "https://scalar.vector.im/",
|
||||||
"integrations_rest_url": "https://scalar.vector.im/api",
|
"integrations_rest_url": "https://scalar.vector.im/api",
|
||||||
@ -19,12 +11,20 @@
|
|||||||
"https://scalar-staging.vector.im/api",
|
"https://scalar-staging.vector.im/api",
|
||||||
"https://scalar-staging.riot.im/scalar/api"
|
"https://scalar-staging.riot.im/scalar/api"
|
||||||
],
|
],
|
||||||
|
"hosting_signup_link": "https://element.io/matrix-services?utm_source=element-web&utm_medium=web",
|
||||||
"bug_report_endpoint_url": "https://element.io/bugreports/submit",
|
"bug_report_endpoint_url": "https://element.io/bugreports/submit",
|
||||||
"uisi_autorageshake_app": "element-auto-uisi",
|
"roomDirectory": {
|
||||||
"room_directory": {
|
"servers": [
|
||||||
"servers": ["matrix.org", "gitter.im"]
|
"matrix.org",
|
||||||
|
"gitter.im"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"showLabsSettings": false,
|
||||||
|
"piwik": {
|
||||||
|
"url": "https://piwik.riot.im/",
|
||||||
|
"siteId": 1,
|
||||||
|
"policyUrl": "https://element.io/cookie-policy"
|
||||||
},
|
},
|
||||||
"show_labs_settings": false,
|
|
||||||
"enable_presence_by_hs_url": {
|
"enable_presence_by_hs_url": {
|
||||||
"https://matrix.org": false,
|
"https://matrix.org": false,
|
||||||
"https://matrix-client.matrix.org": false
|
"https://matrix-client.matrix.org": false
|
||||||
@ -38,22 +38,5 @@
|
|||||||
"url": "https://element.io/cookie-policy",
|
"url": "https://element.io/cookie-policy",
|
||||||
"text": "Cookie Policy"
|
"text": "Cookie Policy"
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
"posthog": {
|
|
||||||
"project_api_key": "phc_Jzsm6DTm6V2705zeU5dcNvQDlonOR68XvX2sh1sEOHO",
|
|
||||||
"api_host": "https://posthog.element.io"
|
|
||||||
},
|
|
||||||
"privacy_policy_url": "https://element.io/cookie-policy",
|
|
||||||
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx",
|
|
||||||
"setting_defaults": {
|
|
||||||
"RustCrypto.staged_rollout_percent": 60
|
|
||||||
},
|
|
||||||
"features": {
|
|
||||||
"feature_video_rooms": true,
|
|
||||||
"feature_group_calls": true,
|
|
||||||
"feature_element_call_video_rooms": true
|
|
||||||
},
|
|
||||||
"element_call": {
|
|
||||||
"url": "https://call.element.io"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
13
element.io/release/control.template
Normal file
13
element.io/release/control.template
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
Package: element-desktop
|
||||||
|
License: Apache-2.0
|
||||||
|
Vendor: support@element.io
|
||||||
|
Architecture: amd64
|
||||||
|
Maintainer: support@element.io
|
||||||
|
Depends: libgtk-3-0, libnotify4, libnss3, libxss1, libxtst6, xdg-utils, libatspi2.0-0, libuuid1, libappindicator3-1, libsecret-1-0, libsqlcipher0
|
||||||
|
Replaces: riot-desktop (<< 1.7.0), riot-web (<< 1.7.0)
|
||||||
|
Breaks: riot-desktop (<< 1.7.0), riot-web (<< 1.7.0)
|
||||||
|
Section: net
|
||||||
|
Priority: extra
|
||||||
|
Homepage: https://element.io/
|
||||||
|
Description:
|
||||||
|
A feature-rich client for Matrix.org
|
||||||
9
element.io/release/riot-desktop_1.7.0_all/DEBIAN/control
Normal file
9
element.io/release/riot-desktop_1.7.0_all/DEBIAN/control
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
Package: riot-desktop
|
||||||
|
Version: 1.7.0
|
||||||
|
Depends: element-desktop
|
||||||
|
Maintainer: packages@element.io
|
||||||
|
Architecture: all
|
||||||
|
Priority: optional
|
||||||
|
Section: oldlibs
|
||||||
|
Description: transitional package
|
||||||
|
This is a transitional package. It can safely be removed.
|
||||||
42
hak/keytar/build.js
Normal file
42
hak/keytar/build.js
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2020 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const path = require('path');
|
||||||
|
const childProcess = require('child_process');
|
||||||
|
|
||||||
|
module.exports = async function(hakEnv, moduleInfo) {
|
||||||
|
await buildKeytar(hakEnv, moduleInfo);
|
||||||
|
};
|
||||||
|
|
||||||
|
async function buildKeytar(hakEnv, moduleInfo) {
|
||||||
|
const env = hakEnv.makeGypEnv();
|
||||||
|
|
||||||
|
console.log("Running yarn with env", env);
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
path.join(moduleInfo.nodeModuleBinDir, 'node-gyp' + (hakEnv.isWin() ? '.cmd' : '')),
|
||||||
|
['rebuild'],
|
||||||
|
{
|
||||||
|
cwd: moduleInfo.moduleBuildDir,
|
||||||
|
env,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
36
hak/keytar/check.js
Normal file
36
hak/keytar/check.js
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2020 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const childProcess = require('child_process');
|
||||||
|
|
||||||
|
module.exports = async function(hakEnv, moduleInfo) {
|
||||||
|
const tools = [['python', '--version']]; // node-gyp uses python for reasons beyond comprehension
|
||||||
|
|
||||||
|
for (const tool of tools) {
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(tool[0], tool.slice(1), {
|
||||||
|
stdio: ['ignore'],
|
||||||
|
});
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
if (code !== 0) {
|
||||||
|
reject("Can't find " + tool);
|
||||||
|
} else {
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
10
hak/keytar/hak.json
Normal file
10
hak/keytar/hak.json
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"scripts": {
|
||||||
|
"check": "check.js",
|
||||||
|
"build": "build.js"
|
||||||
|
},
|
||||||
|
"copy": "build/Release/keytar.node",
|
||||||
|
"dependencies": {
|
||||||
|
"libsecret": "0.20.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
269
hak/matrix-seshat/build.js
Normal file
269
hak/matrix-seshat/build.js
Normal file
@ -0,0 +1,269 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2020 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const path = require('path');
|
||||||
|
const childProcess = require('child_process');
|
||||||
|
|
||||||
|
const mkdirp = require('mkdirp');
|
||||||
|
const fsExtra = require('fs-extra');
|
||||||
|
|
||||||
|
module.exports = async function(hakEnv, moduleInfo) {
|
||||||
|
if (hakEnv.isWin()) {
|
||||||
|
await buildOpenSslWin(hakEnv, moduleInfo);
|
||||||
|
await buildSqlCipherWin(hakEnv, moduleInfo);
|
||||||
|
} else if (hakEnv.isMac()) {
|
||||||
|
await buildSqlCipherUnix(hakEnv, moduleInfo);
|
||||||
|
}
|
||||||
|
await buildMatrixSeshat(hakEnv, moduleInfo);
|
||||||
|
};
|
||||||
|
|
||||||
|
async function buildOpenSslWin(hakEnv, moduleInfo) {
|
||||||
|
const version = moduleInfo.cfg.dependencies.openssl;
|
||||||
|
const openSslDir = path.join(moduleInfo.moduleDotHakDir, `openssl-${version}`);
|
||||||
|
|
||||||
|
const openSslArch = hakEnv.arch === 'x64' ? 'VC-WIN64A' : 'VC-WIN32';
|
||||||
|
|
||||||
|
console.log("Building openssl in " + openSslDir);
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'perl',
|
||||||
|
[
|
||||||
|
'Configure',
|
||||||
|
'--prefix=' + moduleInfo.depPrefix,
|
||||||
|
// sqlcipher only uses about a tiny part of openssl. We link statically
|
||||||
|
// so will only pull in the symbols we use, but we may as well turn off
|
||||||
|
// as much as possible to save on build time.
|
||||||
|
'no-afalgeng',
|
||||||
|
'no-capieng',
|
||||||
|
'no-cms',
|
||||||
|
'no-ct',
|
||||||
|
'no-deprecated',
|
||||||
|
'no-dgram',
|
||||||
|
'no-dso',
|
||||||
|
'no-ec',
|
||||||
|
'no-ec2m',
|
||||||
|
'no-gost',
|
||||||
|
'no-nextprotoneg',
|
||||||
|
'no-ocsp',
|
||||||
|
'no-sock',
|
||||||
|
'no-srp',
|
||||||
|
'no-srtp',
|
||||||
|
'no-tests',
|
||||||
|
'no-ssl',
|
||||||
|
'no-tls',
|
||||||
|
'no-dtls',
|
||||||
|
'no-shared',
|
||||||
|
'no-aria',
|
||||||
|
'no-camellia',
|
||||||
|
'no-cast',
|
||||||
|
'no-chacha',
|
||||||
|
'no-cmac',
|
||||||
|
'no-des',
|
||||||
|
'no-dh',
|
||||||
|
'no-dsa',
|
||||||
|
'no-ecdh',
|
||||||
|
'no-ecdsa',
|
||||||
|
'no-idea',
|
||||||
|
'no-md4',
|
||||||
|
'no-mdc2',
|
||||||
|
'no-ocb',
|
||||||
|
'no-poly1305',
|
||||||
|
'no-rc2',
|
||||||
|
'no-rc4',
|
||||||
|
'no-rmd160',
|
||||||
|
'no-scrypt',
|
||||||
|
'no-seed',
|
||||||
|
'no-siphash',
|
||||||
|
'no-sm2',
|
||||||
|
'no-sm3',
|
||||||
|
'no-sm4',
|
||||||
|
'no-whirlpool',
|
||||||
|
openSslArch,
|
||||||
|
],
|
||||||
|
{
|
||||||
|
cwd: openSslDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'nmake',
|
||||||
|
['build_libs'],
|
||||||
|
{
|
||||||
|
cwd: openSslDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'nmake',
|
||||||
|
['install_dev'],
|
||||||
|
{
|
||||||
|
cwd: openSslDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function buildSqlCipherWin(hakEnv, moduleInfo) {
|
||||||
|
const version = moduleInfo.cfg.dependencies.sqlcipher;
|
||||||
|
const sqlCipherDir = path.join(moduleInfo.moduleDotHakDir, `sqlcipher-${version}`);
|
||||||
|
const buildDir = path.join(sqlCipherDir, 'bld');
|
||||||
|
|
||||||
|
await mkdirp(buildDir);
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'nmake',
|
||||||
|
['/f', path.join('..', 'Makefile.msc'), 'libsqlite3.lib', 'TOP=..'],
|
||||||
|
{
|
||||||
|
cwd: buildDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
env: Object.assign({}, process.env, {
|
||||||
|
CCOPTS: "-DSQLITE_HAS_CODEC -I" + path.join(moduleInfo.depPrefix, 'include'),
|
||||||
|
LTLIBPATHS: "/LIBPATH:" + path.join(moduleInfo.depPrefix, 'lib'),
|
||||||
|
LTLIBS: "libcrypto.lib",
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
await fsExtra.copy(
|
||||||
|
path.join(buildDir, 'libsqlite3.lib'),
|
||||||
|
path.join(moduleInfo.depPrefix, 'lib', 'sqlcipher.lib'),
|
||||||
|
);
|
||||||
|
|
||||||
|
await fsExtra.copy(
|
||||||
|
path.join(buildDir, 'sqlite3.h'),
|
||||||
|
path.join(moduleInfo.depPrefix, 'include', 'sqlcipher.h'),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function buildSqlCipherUnix(hakEnv, moduleInfo) {
|
||||||
|
const version = moduleInfo.cfg.dependencies.sqlcipher;
|
||||||
|
const sqlCipherDir = path.join(moduleInfo.moduleDotHakDir, `sqlcipher-${version}`);
|
||||||
|
|
||||||
|
const args = [
|
||||||
|
'--prefix=' + moduleInfo.depPrefix + '',
|
||||||
|
'--enable-tempstore=yes',
|
||||||
|
'--enable-shared=no',
|
||||||
|
];
|
||||||
|
|
||||||
|
if (hakEnv.isMac()) {
|
||||||
|
args.push('--with-crypto-lib=commoncrypto');
|
||||||
|
}
|
||||||
|
args.push('CFLAGS=-DSQLITE_HAS_CODEC');
|
||||||
|
if (hakEnv.isMac()) {
|
||||||
|
args.push('LDFLAGS=-framework Security -framework Foundation');
|
||||||
|
}
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
path.join(sqlCipherDir, 'configure'),
|
||||||
|
args,
|
||||||
|
{
|
||||||
|
cwd: sqlCipherDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'make',
|
||||||
|
[],
|
||||||
|
{
|
||||||
|
cwd: sqlCipherDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'make',
|
||||||
|
['install'],
|
||||||
|
{
|
||||||
|
cwd: sqlCipherDir,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function buildMatrixSeshat(hakEnv, moduleInfo) {
|
||||||
|
const env = hakEnv.makeGypEnv();
|
||||||
|
|
||||||
|
if (!hakEnv.isLinux()) {
|
||||||
|
Object.assign(env, {
|
||||||
|
SQLCIPHER_STATIC: 1,
|
||||||
|
SQLCIPHER_LIB_DIR: path.join(moduleInfo.depPrefix, 'lib'),
|
||||||
|
SQLCIPHER_INCLUDE_DIR: path.join(moduleInfo.depPrefix, 'include'),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (hakEnv.isWin()) {
|
||||||
|
env.RUSTFLAGS = '-Ctarget-feature=+crt-static -Clink-args=libcrypto.lib';
|
||||||
|
// Note that in general, you can specify targets in Rust without having to have
|
||||||
|
// the matching toolchain, however for this, cargo gets confused when building
|
||||||
|
// the build scripts since they run on the host, but vcvarsall.bat sets the c
|
||||||
|
// compiler in the path to be the one for the target, so we just use the matching
|
||||||
|
// toolchain for the target architecture which makes everything happy.
|
||||||
|
env.RUSTUP_TOOLCHAIN = hakEnv.arch == 'x64' ? 'stable-x86_64-pc-windows-msvc' : 'stable-i686-pc-windows-msvc';
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("Running neon with env", env);
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
path.join(moduleInfo.nodeModuleBinDir, 'neon' + (hakEnv.isWin() ? '.cmd' : '')),
|
||||||
|
['build', '--release'],
|
||||||
|
{
|
||||||
|
cwd: moduleInfo.moduleBuildDir,
|
||||||
|
env,
|
||||||
|
stdio: 'inherit',
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
@ -1,34 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright 2024 New Vector Ltd.
|
|
||||||
Copyright 2020, 2021 The Matrix.org Foundation C.I.C.
|
|
||||||
|
|
||||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
||||||
Please see LICENSE files in the repository root for full details.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import type HakEnv from "../../scripts/hak/hakEnv.js";
|
|
||||||
import type { DependencyInfo } from "../../scripts/hak/dep.js";
|
|
||||||
|
|
||||||
export default async function (hakEnv: HakEnv, moduleInfo: DependencyInfo): Promise<void> {
|
|
||||||
const env = hakEnv.makeGypEnv();
|
|
||||||
|
|
||||||
if (!hakEnv.isHost()) {
|
|
||||||
env.CARGO_BUILD_TARGET = hakEnv.getTargetId();
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log("Running yarn install");
|
|
||||||
await hakEnv.spawn("yarn", ["install"], {
|
|
||||||
cwd: moduleInfo.moduleBuildDir,
|
|
||||||
env,
|
|
||||||
shell: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
const buildTarget = hakEnv.wantsStaticSqlCipher() ? "build-bundled" : "build";
|
|
||||||
|
|
||||||
console.log("Running yarn build");
|
|
||||||
await hakEnv.spawn("yarn", ["run", buildTarget], {
|
|
||||||
cwd: moduleInfo.moduleBuildDir,
|
|
||||||
env,
|
|
||||||
shell: true,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
60
hak/matrix-seshat/check.js
Normal file
60
hak/matrix-seshat/check.js
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2020 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const childProcess = require('child_process');
|
||||||
|
|
||||||
|
module.exports = async function(hakEnv, moduleInfo) {
|
||||||
|
// of course tcl doesn't have a --version
|
||||||
|
if (!hakEnv.isLinux()) {
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn('tclsh', [], {
|
||||||
|
stdio: ['pipe', 'ignore', 'ignore'],
|
||||||
|
});
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
if (code !== 0) {
|
||||||
|
reject("Can't find tclsh - have you installed TCL?");
|
||||||
|
} else {
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
proc.stdin.end();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const tools = [['python', '--version']]; // node-gyp uses python for reasons beyond comprehension
|
||||||
|
if (hakEnv.isWin()) {
|
||||||
|
tools.push(['perl', '--version']); // for openssl configure
|
||||||
|
tools.push(['patch', '--version']); // to patch sqlcipher Makefile.msc
|
||||||
|
tools.push(['nmake', '/?']);
|
||||||
|
} else {
|
||||||
|
tools.push(['make', '--version']);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const tool of tools) {
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const proc = childProcess.spawn(tool[0], tool.slice(1), {
|
||||||
|
stdio: ['ignore'],
|
||||||
|
});
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
if (code !== 0) {
|
||||||
|
reject("Can't find " + tool);
|
||||||
|
} else {
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
@ -1,55 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright 2024 New Vector Ltd.
|
|
||||||
Copyright 2020, 2021 The Matrix.org Foundation C.I.C.
|
|
||||||
|
|
||||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
||||||
Please see LICENSE files in the repository root for full details.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import childProcess from "node:child_process";
|
|
||||||
import fsProm from "node:fs/promises";
|
|
||||||
|
|
||||||
import type HakEnv from "../../scripts/hak/hakEnv.js";
|
|
||||||
import type { Tool } from "../../scripts/hak/hakEnv.js";
|
|
||||||
import type { DependencyInfo } from "../../scripts/hak/dep.js";
|
|
||||||
|
|
||||||
export default async function (hakEnv: HakEnv, moduleInfo: DependencyInfo): Promise<void> {
|
|
||||||
const tools: Tool[] = [
|
|
||||||
["rustc", "--version"],
|
|
||||||
["python", "--version"], // node-gyp uses python for reasons beyond comprehension
|
|
||||||
];
|
|
||||||
if (hakEnv.isWin()) {
|
|
||||||
tools.push(["perl", "--version"]); // for openssl configure
|
|
||||||
tools.push(["nasm", "-v"]); // for openssl building
|
|
||||||
tools.push(["patch", "--version"]); // to patch sqlcipher Makefile.msc
|
|
||||||
tools.push(["nmake", "/?"]);
|
|
||||||
} else {
|
|
||||||
tools.push(["make", "--version"]);
|
|
||||||
}
|
|
||||||
await hakEnv.checkTools(tools);
|
|
||||||
|
|
||||||
// Ensure Rust target exists (nb. we avoid depending on rustup)
|
|
||||||
await new Promise((resolve, reject) => {
|
|
||||||
const rustc = childProcess.execFile(
|
|
||||||
"rustc",
|
|
||||||
["--target", hakEnv.getTargetId(), "--emit=obj", "-o", "tmp", "-"],
|
|
||||||
(err, out) => {
|
|
||||||
if (err) {
|
|
||||||
reject(
|
|
||||||
"rustc can't build for target " +
|
|
||||||
hakEnv.getTargetId() +
|
|
||||||
": ensure target is installed via `rustup target add " +
|
|
||||||
hakEnv.getTargetId() +
|
|
||||||
"` " +
|
|
||||||
"or your package manager if not using `rustup`",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
fsProm.unlink("tmp").then(resolve);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
rustc.stdin!.write("fn main() {}");
|
|
||||||
rustc.stdout!.pipe(process.stdout);
|
|
||||||
rustc.stderr!.pipe(process.stderr);
|
|
||||||
rustc.stdin!.end();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
129
hak/matrix-seshat/fetchDeps.js
Normal file
129
hak/matrix-seshat/fetchDeps.js
Normal file
@ -0,0 +1,129 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2020 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const path = require('path');
|
||||||
|
const childProcess = require('child_process');
|
||||||
|
|
||||||
|
const fs = require('fs');
|
||||||
|
const fsProm = require('fs').promises;
|
||||||
|
const needle = require('needle');
|
||||||
|
const tar = require('tar');
|
||||||
|
|
||||||
|
module.exports = async function(hakEnv, moduleInfo) {
|
||||||
|
if (!hakEnv.isLinux()) {
|
||||||
|
await getSqlCipher(hakEnv, moduleInfo);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (hakEnv.isWin()) {
|
||||||
|
await getOpenSsl(hakEnv, moduleInfo);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
async function getSqlCipher(hakEnv, moduleInfo) {
|
||||||
|
const version = moduleInfo.cfg.dependencies.sqlcipher;
|
||||||
|
const sqlCipherDir = path.join(moduleInfo.moduleDotHakDir, `sqlcipher-${version}`);
|
||||||
|
|
||||||
|
let haveSqlcipher;
|
||||||
|
try {
|
||||||
|
await fsProm.stat(sqlCipherDir);
|
||||||
|
haveSqlcipher = true;
|
||||||
|
} catch (e) {
|
||||||
|
haveSqlcipher = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (haveSqlcipher) return;
|
||||||
|
|
||||||
|
const sqlCipherTarball = path.join(moduleInfo.moduleDotHakDir, `sqlcipher-${version}.tar.gz`);
|
||||||
|
let haveSqlcipherTar;
|
||||||
|
try {
|
||||||
|
await fsProm.stat(sqlCipherTarball);
|
||||||
|
haveSqlcipherTar = true;
|
||||||
|
} catch (e) {
|
||||||
|
haveSqlcipherTar = false;
|
||||||
|
}
|
||||||
|
if (!haveSqlcipherTar) {
|
||||||
|
const bob = needle('get', `https://github.com/sqlcipher/sqlcipher/archive/v${version}.tar.gz`, {
|
||||||
|
follow: 10,
|
||||||
|
output: sqlCipherTarball,
|
||||||
|
});
|
||||||
|
await bob;
|
||||||
|
}
|
||||||
|
|
||||||
|
await tar.x({
|
||||||
|
file: sqlCipherTarball,
|
||||||
|
cwd: moduleInfo.moduleDotHakDir,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (hakEnv.isWin()) {
|
||||||
|
// On Windows, we need to patch the makefile because it forces TEMP_STORE to
|
||||||
|
// default to files (1) but the README specifically says you '*must*' set it
|
||||||
|
// set it to 2 (default to memory).
|
||||||
|
const patchFile = path.join(moduleInfo.moduleHakDir, `sqlcipher-${version}-win.patch`);
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
const readStream = fs.createReadStream(patchFile);
|
||||||
|
|
||||||
|
const proc = childProcess.spawn(
|
||||||
|
'patch',
|
||||||
|
['-p1'],
|
||||||
|
{
|
||||||
|
cwd: sqlCipherDir,
|
||||||
|
stdio: ['pipe', 'inherit', 'inherit'],
|
||||||
|
},
|
||||||
|
);
|
||||||
|
proc.on('exit', (code) => {
|
||||||
|
code ? reject(code) : resolve();
|
||||||
|
});
|
||||||
|
readStream.pipe(proc.stdin);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function getOpenSsl(hakEnv, moduleInfo) {
|
||||||
|
const version = moduleInfo.cfg.dependencies.openssl;
|
||||||
|
const openSslDir = path.join(moduleInfo.moduleDotHakDir, `openssl-${version}`);
|
||||||
|
|
||||||
|
let haveOpenSsl;
|
||||||
|
try {
|
||||||
|
await fsProm.stat(openSslDir);
|
||||||
|
haveOpenSsl = true;
|
||||||
|
} catch (e) {
|
||||||
|
haveOpenSsl = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (haveOpenSsl) return;
|
||||||
|
|
||||||
|
const openSslTarball = path.join(moduleInfo.moduleDotHakDir, `openssl-${version}.tar.gz`);
|
||||||
|
let haveOpenSslTar;
|
||||||
|
try {
|
||||||
|
await fsProm.stat(openSslTarball);
|
||||||
|
haveOpenSslTar = true;
|
||||||
|
} catch (e) {
|
||||||
|
haveOpenSslTar = false;
|
||||||
|
}
|
||||||
|
if (!haveOpenSslTar) {
|
||||||
|
await needle('get', `https://www.openssl.org/source/openssl-${version}.tar.gz`, {
|
||||||
|
follow: 10,
|
||||||
|
output: openSslTarball,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("extracting " + openSslTarball + " in " + moduleInfo.moduleDotHakDir);
|
||||||
|
await tar.x({
|
||||||
|
file: openSslTarball,
|
||||||
|
cwd: moduleInfo.moduleDotHakDir,
|
||||||
|
});
|
||||||
|
}
|
||||||
@ -1,7 +1,13 @@
|
|||||||
{
|
{
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"check": "check.ts",
|
"check": "check.js",
|
||||||
"build": "build.ts"
|
"fetchDeps": "fetchDeps.js",
|
||||||
|
"build": "build.js"
|
||||||
},
|
},
|
||||||
"copy": "index.node"
|
"prune": "native",
|
||||||
|
"copy": "native/index.node",
|
||||||
|
"dependencies": {
|
||||||
|
"openssl": "1.1.1f",
|
||||||
|
"sqlcipher": "4.3.0"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
14
hak/matrix-seshat/sqlcipher-4.3.0-win.patch
Normal file
14
hak/matrix-seshat/sqlcipher-4.3.0-win.patch
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
diff -Nur sqlcipher-4.3.0-orig/Makefile.msc sqlcipher-4.3.0-mod/Makefile.msc
|
||||||
|
--- sqlcipher-4.3.0-orig/Makefile.msc 2019-12-20 16:40:26.000000000 +0000
|
||||||
|
+++ sqlcipher-4.3.0-mod/Makefile.msc 2020-02-14 11:31:39.000000000 +0000
|
||||||
|
@@ -985,8 +985,8 @@
|
||||||
|
# default to file, 2 to default to memory, and 3 to force temporary
|
||||||
|
# tables to always be in memory.
|
||||||
|
#
|
||||||
|
-TCC = $(TCC) -DSQLITE_TEMP_STORE=1
|
||||||
|
-RCC = $(RCC) -DSQLITE_TEMP_STORE=1
|
||||||
|
+TCC = $(TCC) -DSQLITE_TEMP_STORE=2
|
||||||
|
+RCC = $(RCC) -DSQLITE_TEMP_STORE=2
|
||||||
|
|
||||||
|
# Enable/disable loadable extensions, and other optional features
|
||||||
|
# based on configuration. (-DSQLITE_OMIT*, -DSQLITE_ENABLE*).
|
||||||
@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"moduleResolution": "node",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"target": "es2022",
|
|
||||||
"sourceMap": false,
|
|
||||||
"strict": true,
|
|
||||||
"lib": ["es2022"]
|
|
||||||
},
|
|
||||||
"include": ["../scripts/@types/*.d.ts", "./**/*.ts"]
|
|
||||||
}
|
|
||||||
15
knip.ts
15
knip.ts
@ -1,15 +0,0 @@
|
|||||||
import { KnipConfig } from "knip";
|
|
||||||
|
|
||||||
export default {
|
|
||||||
entry: ["src/electron-main.ts", "src/preload.ts", "electron-builder.ts", ".eslintrc-*.js", "scripts/**", "hak/**"],
|
|
||||||
project: ["**/*.{js,ts}"],
|
|
||||||
ignoreDependencies: [
|
|
||||||
// Brought in via hak scripts
|
|
||||||
"matrix-seshat",
|
|
||||||
// Required for `action-validator`
|
|
||||||
"@action-validator/*",
|
|
||||||
// Used for git pre-commit hooks
|
|
||||||
"husky",
|
|
||||||
],
|
|
||||||
ignoreBinaries: ["jq", "scripts/in-docker.sh"],
|
|
||||||
} satisfies KnipConfig;
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
{
|
|
||||||
"readKey": "a7688614897667993891-866e2615b0a22e6ccef56aea9b10e815efa3e1296752a7a30bd9925f1a8f33e7",
|
|
||||||
|
|
||||||
"upload": {
|
|
||||||
"type": "json",
|
|
||||||
"keySeparator": "|",
|
|
||||||
"deprecate": "file",
|
|
||||||
"features": ["plural_object", "filter_untranslated"],
|
|
||||||
"files": [
|
|
||||||
{
|
|
||||||
"pattern": "src/i18n/strings/en_EN.json",
|
|
||||||
"file": "element-desktop.json",
|
|
||||||
"lang": "inherited"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"group": "existing",
|
|
||||||
"pattern": "src/i18n/strings/*.json",
|
|
||||||
"file": "element-desktop.json",
|
|
||||||
"excludes": ["src/i18n/strings/en_EN.json"],
|
|
||||||
"lang": "${autodetectLang}"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
|
|
||||||
"download": {
|
|
||||||
"files": [
|
|
||||||
{
|
|
||||||
"conditions": "equals: ${file}, element-desktop.json",
|
|
||||||
"output": "src/i18n/strings/${langLsrUnderscore}.json"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"includeSourceLang": "${includeSourceLang|false}",
|
|
||||||
"langAliases": {
|
|
||||||
"en": "en-EN"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
179
package.json
179
package.json
@ -1,122 +1,113 @@
|
|||||||
{
|
{
|
||||||
"name": "element-desktop",
|
"name": "element-desktop",
|
||||||
"productName": "Element",
|
"productName": "Element",
|
||||||
"main": "lib/electron-main.js",
|
"main": "src/electron-main.js",
|
||||||
"exports": "./lib/electron-main.js",
|
"version": "1.7.23",
|
||||||
"version": "1.11.94",
|
"description": "A feature-rich client for Matrix.org",
|
||||||
"description": "Element: the future of secure communication",
|
|
||||||
"author": "Element",
|
"author": "Element",
|
||||||
"homepage": "https://element.io",
|
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/vector-im/element-desktop"
|
"url": "https://github.com/vector-im/element-desktop"
|
||||||
},
|
},
|
||||||
"license": "SEE LICENSE IN README.md",
|
"license": "Apache-2.0",
|
||||||
"type": "module",
|
|
||||||
"files": [],
|
"files": [],
|
||||||
"engines": {
|
|
||||||
"node": ">=18.0.0"
|
|
||||||
},
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"i18n": "matrix-gen-i18n && yarn i18n:sort && yarn i18n:lint",
|
|
||||||
"i18n:sort": "jq --sort-keys '.' src/i18n/strings/en_EN.json > src/i18n/strings/en_EN.json.tmp && mv src/i18n/strings/en_EN.json.tmp src/i18n/strings/en_EN.json",
|
|
||||||
"i18n:lint": "prettier --log-level=silent --write src/i18n/strings/ --ignore-path /dev/null",
|
|
||||||
"i18n:diff": "cp src/i18n/strings/en_EN.json src/i18n/strings/en_EN_orig.json && yarn i18n && matrix-compare-i18n-files src/i18n/strings/en_EN_orig.json src/i18n/strings/en_EN.json",
|
|
||||||
"mkdirs": "mkdirp packages deploys",
|
"mkdirs": "mkdirp packages deploys",
|
||||||
"fetch": "yarn run mkdirs && tsx scripts/fetch-package.ts",
|
"fetch": "yarn run mkdirs && node scripts/fetch-package.js",
|
||||||
"asar-webapp": "asar p webapp webapp.asar",
|
"asar-webapp": "asar p webapp webapp.asar",
|
||||||
"start": "yarn run build:ts && yarn run build:res && electron .",
|
"start": "electron .",
|
||||||
"lint": "yarn lint:types && yarn lint:js && yarn lint:workflows",
|
"lint": "eslint src/ scripts/ hak/",
|
||||||
"lint:js": "eslint --max-warnings 0 src hak playwright scripts && prettier --check .",
|
|
||||||
"lint:js-fix": "eslint --fix --max-warnings 0 src hak playwright scripts && prettier --log-level=warn --write .",
|
|
||||||
"lint:types": "yarn lint:types:src && yarn lint:types:test && yarn lint:types:scripts && yarn lint:types:hak",
|
|
||||||
"lint:types:src": "tsc --noEmit",
|
|
||||||
"lint:types:test": "tsc --noEmit -p playwright/tsconfig.json",
|
|
||||||
"lint:types:scripts": "tsc --noEmit -p scripts/tsconfig.json",
|
|
||||||
"lint:types:hak": "tsc --noEmit -p hak/tsconfig.json",
|
|
||||||
"lint:workflows": "find .github/workflows -type f \\( -iname '*.yaml' -o -iname '*.yml' \\) | xargs -I {} sh -c 'echo \"Linting {}\"; action-validator \"{}\"'",
|
|
||||||
"lint:knip": "knip",
|
|
||||||
"build:native": "yarn run hak",
|
"build:native": "yarn run hak",
|
||||||
"build:native:universal": "yarn run hak --target x86_64-apple-darwin fetchandbuild && yarn run hak --target aarch64-apple-darwin fetchandbuild && yarn run hak --target x86_64-apple-darwin --target aarch64-apple-darwin copyandlink",
|
"build32": "electron-builder --ia32",
|
||||||
"build:32": "yarn run build:ts && yarn run build:res && electron-builder --ia32",
|
"build64": "electron-builder --x64",
|
||||||
"build:64": "yarn run build:ts && yarn run build:res && electron-builder --x64",
|
"build": "electron-builder",
|
||||||
"build:universal": "yarn run build:ts && yarn run build:res && electron-builder --universal",
|
"docker:setup": "docker build -t element-desktop-dockerbuild dockerbuild",
|
||||||
"build": "yarn run build:ts && yarn run build:res && electron-builder",
|
|
||||||
"build:ts": "tsc",
|
|
||||||
"build:res": "tsx scripts/copy-res.ts",
|
|
||||||
"docker:setup": "docker build --platform linux/amd64 -t element-desktop-dockerbuild -f dockerbuild/Dockerfile .",
|
|
||||||
"docker:build:native": "scripts/in-docker.sh yarn run hak",
|
"docker:build:native": "scripts/in-docker.sh yarn run hak",
|
||||||
"docker:build": "scripts/in-docker.sh yarn run build",
|
"docker:build": "scripts/in-docker.sh yarn run build",
|
||||||
"docker:install": "scripts/in-docker.sh yarn install",
|
"docker:install": "scripts/in-docker.sh yarn install",
|
||||||
"clean": "rimraf webapp.asar dist packages deploys lib",
|
"debrepo": "scripts/mkrepo.sh",
|
||||||
"hak": "tsx scripts/hak/index.ts",
|
"clean": "rimraf webapp.asar dist packages deploys",
|
||||||
"test": "playwright test",
|
"hak": "node scripts/hak/index.js"
|
||||||
"test:open": "yarn test --ui",
|
|
||||||
"test:screenshots:build": "docker build playwright -t element-desktop-playwright --platform linux/amd64",
|
|
||||||
"test:screenshots:run": "docker run --rm --network host -v $(pwd):/work/element-desktop -v /var/run/docker.sock:/var/run/docker.sock --platform linux/amd64 -it element-desktop-playwright",
|
|
||||||
"postinstall": "electron-builder install-app-deps"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@sentry/electron": "^6.0.0",
|
|
||||||
"@standardnotes/electron-clear-data": "^1.0.5",
|
|
||||||
"auto-launch": "^5.0.5",
|
"auto-launch": "^5.0.5",
|
||||||
"counterpart": "^0.18.6",
|
"electron-store": "^6.0.1",
|
||||||
"electron-store": "^10.0.0",
|
|
||||||
"electron-window-state": "^5.0.3",
|
"electron-window-state": "^5.0.3",
|
||||||
"keytar-forked": "7.10.0",
|
"minimist": "^1.2.3",
|
||||||
"minimist": "^1.2.6",
|
|
||||||
"png-to-ico": "^2.1.1",
|
"png-to-ico": "^2.1.1",
|
||||||
"uuid": "^11.0.0"
|
"request": "^2.88.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@action-validator/cli": "^0.6.0",
|
"asar": "^2.0.1",
|
||||||
"@action-validator/core": "^0.6.0",
|
"electron-builder": "22.9.1",
|
||||||
"@babel/core": "^7.18.10",
|
"electron-builder-squirrel-windows": "22.9.1",
|
||||||
"@babel/preset-env": "^7.18.10",
|
"electron-devtools-installer": "^3.1.1",
|
||||||
"@babel/preset-typescript": "^7.18.6",
|
"electron-notarize": "^1.0.0",
|
||||||
"@electron/asar": "3.3.1",
|
"eslint": "7.3.1",
|
||||||
"@playwright/test": "1.50.1",
|
"eslint-config-matrix-org": "^0.1.2",
|
||||||
"@stylistic/eslint-plugin": "^3.0.0",
|
"find-npm-prefix": "^1.0.2",
|
||||||
"@types/auto-launch": "^5.0.1",
|
"fs-extra": "^8.1.0",
|
||||||
"@types/counterpart": "^0.18.1",
|
"glob": "^7.1.6",
|
||||||
"@types/minimist": "^1.2.1",
|
"mkdirp": "^1.0.3",
|
||||||
"@types/node": "18.19.79",
|
"needle": "^2.5.0",
|
||||||
"@types/pacote": "^11.1.1",
|
"node-pre-gyp": "^0.15.0",
|
||||||
"@typescript-eslint/eslint-plugin": "^8.0.0",
|
"npm": "^6.14.11",
|
||||||
"@typescript-eslint/parser": "^8.0.0",
|
"rimraf": "^3.0.2",
|
||||||
"app-builder-lib": "26.0.10",
|
"semver": "^7.3.4",
|
||||||
"chokidar": "^4.0.0",
|
"tar": "^6.1.0"
|
||||||
"detect-libc": "^2.0.0",
|
|
||||||
"electron": "34.3.0",
|
|
||||||
"electron-builder": "26.0.10",
|
|
||||||
"electron-builder-squirrel-windows": "26.0.10",
|
|
||||||
"electron-devtools-installer": "^4.0.0",
|
|
||||||
"eslint": "^8.26.0",
|
|
||||||
"eslint-config-google": "^0.14.0",
|
|
||||||
"eslint-config-prettier": "^10.0.0",
|
|
||||||
"eslint-plugin-import": "^2.25.4",
|
|
||||||
"eslint-plugin-matrix-org": "^2.0.1",
|
|
||||||
"eslint-plugin-n": "^17.12.0",
|
|
||||||
"eslint-plugin-unicorn": "^56.0.0",
|
|
||||||
"glob": "^11.0.0",
|
|
||||||
"husky": "^9.1.6",
|
|
||||||
"knip": "^5.0.0",
|
|
||||||
"lint-staged": "^15.2.10",
|
|
||||||
"matrix-web-i18n": "^3.2.1",
|
|
||||||
"mkdirp": "^3.0.0",
|
|
||||||
"pacote": "^21.0.0",
|
|
||||||
"plist": "^3.1.0",
|
|
||||||
"prettier": "^3.0.0",
|
|
||||||
"rimraf": "^6.0.0",
|
|
||||||
"tar": "^7.0.0",
|
|
||||||
"tsx": "^4.19.2",
|
|
||||||
"typescript": "5.8.2"
|
|
||||||
},
|
},
|
||||||
"hakDependencies": {
|
"hakDependencies": {
|
||||||
"matrix-seshat": "^4.0.1"
|
"matrix-seshat": "^2.2.3",
|
||||||
|
"keytar": "^5.6.0"
|
||||||
},
|
},
|
||||||
"resolutions": {
|
"build": {
|
||||||
"@types/node": "18.19.79",
|
"appId": "im.riot.app",
|
||||||
"config-file-ts": "0.2.8-rc1"
|
"electronVersion": "11.2.3",
|
||||||
|
"files": [
|
||||||
|
"package.json",
|
||||||
|
{
|
||||||
|
"from": ".hak/hakModules",
|
||||||
|
"to": "node_modules"
|
||||||
|
},
|
||||||
|
"src/**"
|
||||||
|
],
|
||||||
|
"extraResources": [
|
||||||
|
{
|
||||||
|
"from": "res/img",
|
||||||
|
"to": "img"
|
||||||
|
},
|
||||||
|
"webapp.asar"
|
||||||
|
],
|
||||||
|
"linux": {
|
||||||
|
"target": "deb",
|
||||||
|
"category": "Network;InstantMessaging;Chat",
|
||||||
|
"maintainer": "support@element.io",
|
||||||
|
"desktop": {
|
||||||
|
"StartupWMClass": "element"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"mac": {
|
||||||
|
"category": "public.app-category.social-networking",
|
||||||
|
"darkModeSupport": true
|
||||||
|
},
|
||||||
|
"win": {
|
||||||
|
"target": {
|
||||||
|
"target": "squirrel"
|
||||||
|
},
|
||||||
|
"sign": "scripts/electron_winSign"
|
||||||
|
},
|
||||||
|
"directories": {
|
||||||
|
"output": "dist"
|
||||||
|
},
|
||||||
|
"afterPack": "scripts/electron_afterPack",
|
||||||
|
"afterSign": "scripts/electron_afterSign",
|
||||||
|
"protocols": [
|
||||||
|
{
|
||||||
|
"name": "element",
|
||||||
|
"schemes": [
|
||||||
|
"element"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,25 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright 2024 New Vector Ltd.
|
|
||||||
Copyright 2023 The Matrix.org Foundation C.I.C.
|
|
||||||
|
|
||||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
||||||
Please see LICENSE files in the repository root for full details.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import { defineConfig } from "@playwright/test";
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
use: {
|
|
||||||
viewport: { width: 1280, height: 720 },
|
|
||||||
video: "retain-on-failure",
|
|
||||||
trace: "on-first-retry",
|
|
||||||
},
|
|
||||||
testDir: "playwright/e2e",
|
|
||||||
outputDir: "playwright/test-results",
|
|
||||||
workers: 1,
|
|
||||||
retries: process.env.CI ? 2 : 0,
|
|
||||||
reporter: [["html", { outputFolder: "playwright/html-report" }]],
|
|
||||||
snapshotDir: "playwright/snapshots",
|
|
||||||
snapshotPathTemplate: "{snapshotDir}/{testFilePath}/{arg}-{platform}{ext}",
|
|
||||||
timeout: 30 * 1000,
|
|
||||||
});
|
|
||||||
5
playwright/.gitignore
vendored
5
playwright/.gitignore
vendored
@ -1,5 +0,0 @@
|
|||||||
/test-results/
|
|
||||||
/html-report/
|
|
||||||
# Only commit snapshots from Linux
|
|
||||||
/snapshots/**/*.png
|
|
||||||
!/snapshots/**/*-linux.png
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
FROM mcr.microsoft.com/playwright:v1.50.1-jammy
|
|
||||||
|
|
||||||
WORKDIR /work/element-desktop
|
|
||||||
|
|
||||||
RUN apt-get update && apt-get -y install xvfb && apt-get purge -y --auto-remove && rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
USER 1000:1000
|
|
||||||
|
|
||||||
COPY docker-entrypoint.sh /opt/docker-entrypoint.sh
|
|
||||||
ENTRYPOINT ["bash", "/opt/docker-entrypoint.sh"]
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
echo "Starting Xvfb"
|
|
||||||
Xvfb :99 -ac &
|
|
||||||
sleep 2
|
|
||||||
|
|
||||||
export DISPLAY=:99
|
|
||||||
|
|
||||||
npx playwright test --update-snapshots --reporter line $1
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright 2024 New Vector Ltd.
|
|
||||||
|
|
||||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
||||||
Please see LICENSE files in the repository root for full details.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import { resolve, dirname } from "node:path";
|
|
||||||
import { fileURLToPath } from "node:url";
|
|
||||||
|
|
||||||
import { test, expect } from "../../element-desktop-test.js";
|
|
||||||
|
|
||||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
||||||
|
|
||||||
test.describe("App config options", () => {
|
|
||||||
test.describe("Should load custom config via env", () => {
|
|
||||||
test.slow();
|
|
||||||
test.use({
|
|
||||||
extraEnv: {
|
|
||||||
ELEMENT_DESKTOP_CONFIG_JSON: resolve(__dirname, "../..", "fixtures/custom-config.json"),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
test("should launch and use configured homeserver", async ({ page }) => {
|
|
||||||
await page.locator("#matrixchat").waitFor();
|
|
||||||
await page.locator(".mx_Welcome").waitFor();
|
|
||||||
await expect(page).toHaveURL("vector://vector/webapp/#/welcome");
|
|
||||||
await page.getByText("Sign in").click();
|
|
||||||
await page.getByText("matrix.example.org", { exact: true }).waitFor();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
test.describe("Should load custom config via argument", () => {
|
|
||||||
test.slow();
|
|
||||||
test.use({
|
|
||||||
extraArgs: ["--config", resolve(__dirname, "../..", "fixtures/custom-config.json")],
|
|
||||||
});
|
|
||||||
test("should launch and use configured homeserver", async ({ page }) => {
|
|
||||||
await page.locator("#matrixchat").waitFor();
|
|
||||||
await page.locator(".mx_Welcome").waitFor();
|
|
||||||
await expect(page).toHaveURL("vector://vector/webapp/#/welcome");
|
|
||||||
await page.getByText("Sign in").click();
|
|
||||||
await page.getByText("matrix.example.org", { exact: true }).waitFor();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@ -1,58 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright 2024 New Vector Ltd.
|
|
||||||
Copyright 2022, 2023 The Matrix.org Foundation C.I.C.
|
|
||||||
|
|
||||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
||||||
Please see LICENSE files in the repository root for full details.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import { platform } from "node:os";
|
|
||||||
|
|
||||||
import { test, expect } from "../../element-desktop-test.js";
|
|
||||||
|
|
||||||
declare global {
|
|
||||||
interface Window {
|
|
||||||
mxPlatformPeg: {
|
|
||||||
get(): {
|
|
||||||
getEventIndexingManager():
|
|
||||||
| {
|
|
||||||
supportsEventIndexing(): Promise<boolean>;
|
|
||||||
}
|
|
||||||
| undefined;
|
|
||||||
createPickleKey(userId: string, deviceId: string): Promise<string | null>;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
test.describe("App launch", () => {
|
|
||||||
test.slow();
|
|
||||||
|
|
||||||
test.beforeEach(async ({ page }) => {
|
|
||||||
await page.locator("#matrixchat").waitFor();
|
|
||||||
await page.locator(".mx_Welcome").waitFor();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should launch and render the welcome view successfully", async ({ page }) => {
|
|
||||||
await expect(page).toHaveURL("vector://vector/webapp/#/welcome");
|
|
||||||
await expect(page).toHaveScreenshot();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should launch and render the welcome view successfully and support seshat", async ({ page }) => {
|
|
||||||
await expect(
|
|
||||||
page.evaluate<boolean>(async () => {
|
|
||||||
return window.mxPlatformPeg.get().getEventIndexingManager()?.supportsEventIndexing();
|
|
||||||
}),
|
|
||||||
).resolves.toBeTruthy();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should launch and render the welcome view successfully and support keytar", async ({ page }) => {
|
|
||||||
test.skip(platform() === "linux", "This test does not yet support Linux");
|
|
||||||
|
|
||||||
await expect(
|
|
||||||
page.evaluate<string | null>(async () => {
|
|
||||||
return await window.mxPlatformPeg.get().createPickleKey("@user:server", "ABCDEF");
|
|
||||||
}),
|
|
||||||
).resolves.not.toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@ -1,74 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright 2024 New Vector Ltd.
|
|
||||||
Copyright 2023 The Matrix.org Foundation C.I.C.
|
|
||||||
|
|
||||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
||||||
Please see LICENSE files in the repository root for full details.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import { _electron as electron, test as base, expect as baseExpect, type ElectronApplication } from "@playwright/test";
|
|
||||||
import fs from "node:fs/promises";
|
|
||||||
import path, { dirname } from "node:path";
|
|
||||||
import os from "node:os";
|
|
||||||
import { fileURLToPath } from "node:url";
|
|
||||||
|
|
||||||
interface Fixtures {
|
|
||||||
app: ElectronApplication;
|
|
||||||
tmpDir: string;
|
|
||||||
extraEnv: Record<string, string>;
|
|
||||||
extraArgs: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
||||||
|
|
||||||
export const test = base.extend<Fixtures>({
|
|
||||||
extraEnv: {},
|
|
||||||
extraArgs: [],
|
|
||||||
// eslint-disable-next-line no-empty-pattern
|
|
||||||
tmpDir: async ({}, use) => {
|
|
||||||
const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "element-desktop-tests-"));
|
|
||||||
console.log("Using temp profile directory: ", tmpDir);
|
|
||||||
await use(tmpDir);
|
|
||||||
await fs.rm(tmpDir, { recursive: true });
|
|
||||||
},
|
|
||||||
app: async ({ tmpDir, extraEnv, extraArgs }, use) => {
|
|
||||||
const args = ["--profile-dir", tmpDir];
|
|
||||||
|
|
||||||
const executablePath = process.env["ELEMENT_DESKTOP_EXECUTABLE"];
|
|
||||||
if (!executablePath) {
|
|
||||||
// Unpackaged mode testing
|
|
||||||
args.unshift(path.join(__dirname, "..", "lib", "electron-main.js"));
|
|
||||||
}
|
|
||||||
|
|
||||||
const app = await electron.launch({
|
|
||||||
env: {
|
|
||||||
...process.env,
|
|
||||||
...extraEnv,
|
|
||||||
},
|
|
||||||
executablePath,
|
|
||||||
args: [...args, ...extraArgs],
|
|
||||||
});
|
|
||||||
|
|
||||||
app.process().stdout.pipe(process.stdout);
|
|
||||||
app.process().stderr.pipe(process.stderr);
|
|
||||||
|
|
||||||
await app.firstWindow();
|
|
||||||
|
|
||||||
// Block matrix.org access to ensure consistent tests
|
|
||||||
const context = app.context();
|
|
||||||
await context.route("https://matrix.org/**", async (route) => {
|
|
||||||
await route.abort();
|
|
||||||
});
|
|
||||||
|
|
||||||
await use(app);
|
|
||||||
},
|
|
||||||
page: async ({ app }, use) => {
|
|
||||||
const window = await app.firstWindow();
|
|
||||||
await use(window);
|
|
||||||
await app.close().catch((e) => {
|
|
||||||
console.error(e);
|
|
||||||
});
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
export const expect = baseExpect;
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"default_server_config": {
|
|
||||||
"m.homeserver": {
|
|
||||||
"base_url": "https://matrix.example.org"
|
|
||||||
},
|
|
||||||
"m.identity_server": {
|
|
||||||
"base_url": "https://identity.example.org"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.1 MiB |
@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"moduleResolution": "node",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"target": "es2022",
|
|
||||||
"module": "es2022",
|
|
||||||
"lib": ["es2022", "dom"]
|
|
||||||
},
|
|
||||||
"include": ["**/*.ts"]
|
|
||||||
}
|
|
||||||
12
release.sh
Executable file
12
release.sh
Executable file
@ -0,0 +1,12 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Script to perform a release of element-desktop.
|
||||||
|
#
|
||||||
|
# Requires githib-changelog-generator; to install, do
|
||||||
|
# pip install git+https://github.com/matrix-org/github-changelog-generator.git
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
cd `dirname $0`
|
||||||
|
|
||||||
|
./node_modules/matrix-js-sdk/release.sh -n -z "$@"
|
||||||
1
release_config.yaml
Normal file
1
release_config.yaml
Normal file
@ -0,0 +1 @@
|
|||||||
|
signing_id: releases@riot.im
|
||||||
5
scripts/ci/install-deps.sh
Executable file
5
scripts/ci/install-deps.sh
Executable file
@ -0,0 +1,5 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
yarn install $@
|
||||||
@ -1,7 +0,0 @@
|
|||||||
REM Batch file to aid in cross-compiling sqlcipher for Windows ARM64
|
|
||||||
REM Full path should be passed to Makefile.msc as NCC env var
|
|
||||||
|
|
||||||
setlocal
|
|
||||||
call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" %VSCMD_ARG_HOST_ARCH%
|
|
||||||
cl.exe %*
|
|
||||||
endlocal
|
|
||||||
@ -1,81 +0,0 @@
|
|||||||
#!/usr/bin/env -S npx tsx
|
|
||||||
|
|
||||||
// copies resources into the lib directory.
|
|
||||||
|
|
||||||
import parseArgs from "minimist";
|
|
||||||
import * as chokidar from "chokidar";
|
|
||||||
import * as path from "node:path";
|
|
||||||
import * as fs from "node:fs";
|
|
||||||
|
|
||||||
const argv = parseArgs(process.argv.slice(2), {});
|
|
||||||
|
|
||||||
const watch = argv.w;
|
|
||||||
const verbose = argv.v;
|
|
||||||
|
|
||||||
function errCheck(err: unknown): void {
|
|
||||||
if (err) {
|
|
||||||
console.error(err instanceof Error ? err.message : err);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const I18N_BASE_PATH = "src/i18n/strings/";
|
|
||||||
const INCLUDE_LANGS = fs.readdirSync(I18N_BASE_PATH).filter((fn) => fn.endsWith(".json"));
|
|
||||||
|
|
||||||
// Ensure lib, lib/i18n and lib/i18n/strings all exist
|
|
||||||
fs.mkdirSync("lib/i18n/strings", { recursive: true });
|
|
||||||
|
|
||||||
type Translations = Record<string, Record<string, string> | string>;
|
|
||||||
|
|
||||||
function genLangFile(file: string, dest: string): void {
|
|
||||||
const translations: Translations = {};
|
|
||||||
[file].forEach(function (f) {
|
|
||||||
if (fs.existsSync(f)) {
|
|
||||||
try {
|
|
||||||
Object.assign(translations, JSON.parse(fs.readFileSync(f).toString()));
|
|
||||||
} catch (e) {
|
|
||||||
console.error("Failed: " + f, e);
|
|
||||||
throw e;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const json = JSON.stringify(translations, null, 4);
|
|
||||||
const filename = path.basename(file);
|
|
||||||
|
|
||||||
fs.writeFileSync(dest + filename, json);
|
|
||||||
if (verbose) {
|
|
||||||
console.log("Generated language file: " + filename);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
watch the input files for a given language,
|
|
||||||
regenerate the file, and regenerating languages.json with the new filename
|
|
||||||
*/
|
|
||||||
function watchLanguage(file: string, dest: string): void {
|
|
||||||
// XXX: Use a debounce because for some reason if we read the language
|
|
||||||
// file immediately after the FS event is received, the file contents
|
|
||||||
// appears empty. Possibly https://github.com/nodejs/node/issues/6112
|
|
||||||
let makeLangDebouncer: NodeJS.Timeout | undefined;
|
|
||||||
const makeLang = (): void => {
|
|
||||||
if (makeLangDebouncer) {
|
|
||||||
clearTimeout(makeLangDebouncer);
|
|
||||||
}
|
|
||||||
makeLangDebouncer = setTimeout(() => {
|
|
||||||
genLangFile(file, dest);
|
|
||||||
}, 500);
|
|
||||||
};
|
|
||||||
|
|
||||||
chokidar.watch(file).on("add", makeLang).on("change", makeLang).on("error", errCheck);
|
|
||||||
}
|
|
||||||
|
|
||||||
// language resources
|
|
||||||
const I18N_DEST = "lib/i18n/strings/";
|
|
||||||
INCLUDE_LANGS.forEach((file): void => {
|
|
||||||
genLangFile(I18N_BASE_PATH + file, I18N_DEST);
|
|
||||||
}, {});
|
|
||||||
|
|
||||||
if (watch) {
|
|
||||||
INCLUDE_LANGS.forEach((file) => watchLanguage(I18N_BASE_PATH + file, I18N_DEST));
|
|
||||||
}
|
|
||||||
15
scripts/electron_afterPack.js
Normal file
15
scripts/electron_afterPack.js
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
const fsProm = require('fs').promises;
|
||||||
|
const path = require('path');
|
||||||
|
|
||||||
|
exports.default = async function(context) {
|
||||||
|
const { electronPlatformName, appOutDir } = context;
|
||||||
|
|
||||||
|
// Squirrel windows will try to relaunch the app using an executable of the same name as
|
||||||
|
// before in the new version, so will fail if the executable is now called something else.
|
||||||
|
// We add a fake Riot.exe that it can run which runs the real one.
|
||||||
|
// This also gets signed automatically, presumably because electron-build just looks for all
|
||||||
|
// exe files and signs them all...
|
||||||
|
if (electronPlatformName === 'win32') {
|
||||||
|
await fsProm.copyFile('build/rebrand_stub/rebrand_stub.exe', path.join(appOutDir, "Riot.exe"));
|
||||||
|
}
|
||||||
|
};
|
||||||
29
scripts/electron_afterSign.js
Normal file
29
scripts/electron_afterSign.js
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
const { notarize } = require('electron-notarize');
|
||||||
|
|
||||||
|
exports.default = async function(context) {
|
||||||
|
const { electronPlatformName, appOutDir } = context;
|
||||||
|
const appId = context.packager.info.appInfo.id;
|
||||||
|
|
||||||
|
if (electronPlatformName === 'darwin') {
|
||||||
|
const appName = context.packager.appInfo.productFilename;
|
||||||
|
// We get the password from keychain. The keychain stores
|
||||||
|
// user IDs too, but apparently altool can't get the user ID
|
||||||
|
// from the keychain, so we need to get it from the environment.
|
||||||
|
const userId = process.env.NOTARIZE_APPLE_ID;
|
||||||
|
if (userId === undefined) {
|
||||||
|
console.log("*************************************");
|
||||||
|
console.log("* NOTARIZE_APPLE_ID is not set. *");
|
||||||
|
console.log("* This build will NOT be notarised. *");
|
||||||
|
console.log("*************************************");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("Notarising macOS app. This may be some time.");
|
||||||
|
return await notarize({
|
||||||
|
appBundleId: appId,
|
||||||
|
appPath: `${appOutDir}/${appName}.app`,
|
||||||
|
appleId: userId,
|
||||||
|
appleIdPassword: '@keychain:NOTARIZE_CREDS',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
74
scripts/electron_winSign.js
Normal file
74
scripts/electron_winSign.js
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
const { execFile } = require('child_process');
|
||||||
|
|
||||||
|
// Loosely based on computeSignToolArgs from app-builder-lib/src/codeSign/windowsCodeSign.ts
|
||||||
|
function computeSignToolArgs(options, keyContainer) {
|
||||||
|
const args = [];
|
||||||
|
|
||||||
|
if (process.env.ELECTRON_BUILDER_OFFLINE !== "true") {
|
||||||
|
const timestampingServiceUrl = options.options.timeStampServer || "http://timestamp.digicert.com";
|
||||||
|
args.push(
|
||||||
|
options.isNest || options.hash === "sha256" ? "/tr" : "/t",
|
||||||
|
options.isNest || options.hash === "sha256" ? (
|
||||||
|
options.options.rfc3161TimeStampServer || "http://timestamp.comodoca.com/rfc3161"
|
||||||
|
) : timestampingServiceUrl,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
args.push('/kc', keyContainer);
|
||||||
|
// To use the hardware token (this should probably be less hardcoded)
|
||||||
|
args.push('/csp', 'eToken Base Cryptographic Provider');
|
||||||
|
// The certificate file. Somehow this appears to be the only way to specify
|
||||||
|
// the cert that works. If you specify the subject name or hash, it will
|
||||||
|
// say it can't associate the private key to the certificate.
|
||||||
|
// TODO: Find a way to pass this through from the electron-builder config
|
||||||
|
// so we don't have to hard-code this here
|
||||||
|
// fwiw https://stackoverflow.com/questions/17927895/automate-extended-validation-ev-code-signing
|
||||||
|
// is about the most useful resource on automating code signing...
|
||||||
|
args.push('/f', 'element.io\\New_Vector_Ltd.pem');
|
||||||
|
|
||||||
|
if (options.hash !== "sha1") {
|
||||||
|
args.push("/fd", options.hash);
|
||||||
|
if (process.env.ELECTRON_BUILDER_OFFLINE !== "true") {
|
||||||
|
args.push("/td", "sha256");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// msi does not support dual-signing
|
||||||
|
if (options.isNest) {
|
||||||
|
args.push("/as");
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://github.com/electron-userland/electron-builder/issues/2875#issuecomment-387233610
|
||||||
|
args.push("/debug");
|
||||||
|
// must be last argument
|
||||||
|
args.push(options.path);
|
||||||
|
|
||||||
|
return args;
|
||||||
|
}
|
||||||
|
|
||||||
|
exports.default = async function(options) {
|
||||||
|
const keyContainer = process.env.SIGNING_KEY_CONTAINER;
|
||||||
|
if (keyContainer === undefined) {
|
||||||
|
console.warn(
|
||||||
|
"!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n" +
|
||||||
|
"! Skipping Windows signing. !\n" +
|
||||||
|
"! SIGNING_KEY_CONTAINER not defined. !\n" +
|
||||||
|
"!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!",
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const args = ['sign'].concat(computeSignToolArgs(options, keyContainer));
|
||||||
|
|
||||||
|
execFile('signtool', args, {}, (error, stdout) => {
|
||||||
|
if (error) {
|
||||||
|
console.error("signtool failed with code " + error);
|
||||||
|
reject("signtool failed with code " + error);
|
||||||
|
console.log(stdout);
|
||||||
|
} else {
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
292
scripts/fetch-package.js
Executable file
292
scripts/fetch-package.js
Executable file
@ -0,0 +1,292 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
const process = require('process');
|
||||||
|
const path = require('path');
|
||||||
|
const fs = require('fs');
|
||||||
|
const fsPromises = require('fs').promises;
|
||||||
|
const childProcess = require('child_process');
|
||||||
|
const tar = require('tar');
|
||||||
|
const asar = require('asar');
|
||||||
|
const needle = require('needle');
|
||||||
|
|
||||||
|
const riotDesktopPackageJson = require('../package.json');
|
||||||
|
|
||||||
|
const PUB_KEY_URL = "https://packages.riot.im/element-release-key.asc";
|
||||||
|
const PACKAGE_URL_PREFIX = "https://github.com/vector-im/element-web/releases/download/";
|
||||||
|
const ASAR_PATH = 'webapp.asar';
|
||||||
|
|
||||||
|
const {setPackageVersion, setDebVersion} = require('./set-version.js');
|
||||||
|
|
||||||
|
async function getLatestDevelopUrl(bkToken) {
|
||||||
|
const buildsResult = await needle('get',
|
||||||
|
"https://api.buildkite.com/v2/organizations/matrix-dot-org/pipelines/element-web/builds",
|
||||||
|
{
|
||||||
|
branch: 'develop',
|
||||||
|
state: 'passed',
|
||||||
|
per_page: 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
headers: {
|
||||||
|
authorization: "Bearer " + bkToken,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const latestBuild = buildsResult.body[0];
|
||||||
|
console.log("Latest build is " + latestBuild.number);
|
||||||
|
let artifactUrl;
|
||||||
|
for (const job of latestBuild.jobs) {
|
||||||
|
// Strip any colon-form emoji from the build name
|
||||||
|
if (job.name && job.name.replace(/:\w*:\s*/, '') === 'Package') {
|
||||||
|
artifactUrl = job.artifacts_url;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (artifactUrl === undefined) {
|
||||||
|
throw new Error("Couldn't find artifact URL - has the name of the package job changed?");
|
||||||
|
}
|
||||||
|
|
||||||
|
const artifactsResult = await needle('get', artifactUrl, {},
|
||||||
|
{
|
||||||
|
headers: {
|
||||||
|
authorization: "Bearer " + bkToken,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
let dlUrl;
|
||||||
|
let dlFilename;
|
||||||
|
for (const artifact of artifactsResult.body) {
|
||||||
|
if (artifact.filename && /^element-.*\.tar.gz$/.test(artifact.filename)) {
|
||||||
|
dlUrl = artifact.download_url;
|
||||||
|
dlFilename = artifact.filename;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (dlUrl === undefined) {
|
||||||
|
throw new Error("Couldn't find artifact download URL - has the artifact filename changed?");
|
||||||
|
}
|
||||||
|
console.log("Fetching artifact URL...");
|
||||||
|
const dlResult = await needle('get', dlUrl, {},
|
||||||
|
{
|
||||||
|
headers: {
|
||||||
|
authorization: "Bearer " + bkToken,
|
||||||
|
},
|
||||||
|
// This URL will give us a Location header, but will also give us
|
||||||
|
// a JSON object with the direct URL. We'll take the URL and pass it
|
||||||
|
// back, then we can easily support specifying a URL directly.
|
||||||
|
follow_max: 0,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
return [dlFilename, dlResult.body.url];
|
||||||
|
}
|
||||||
|
|
||||||
|
async function downloadToFile(url, filename) {
|
||||||
|
console.log("Downloading " + url + "...");
|
||||||
|
|
||||||
|
try {
|
||||||
|
await needle('get', url, null,
|
||||||
|
{
|
||||||
|
follow_max: 5,
|
||||||
|
output: filename,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
} catch (e) {
|
||||||
|
try {
|
||||||
|
await fsPromises.unlink(filename);
|
||||||
|
} catch (_) {}
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function verifyFile(filename) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
childProcess.execFile('gpg', ['--verify', filename + '.asc', filename], (error) => {
|
||||||
|
if (error) {
|
||||||
|
reject(error);
|
||||||
|
} else {
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
let verify = true;
|
||||||
|
let importkey = false;
|
||||||
|
let pkgDir = 'packages';
|
||||||
|
let deployDir = 'deploys';
|
||||||
|
let cfgDir;
|
||||||
|
let targetVersion;
|
||||||
|
let filename;
|
||||||
|
let url;
|
||||||
|
let setVersion = false;
|
||||||
|
|
||||||
|
while (process.argv.length > 2) {
|
||||||
|
switch (process.argv[2]) {
|
||||||
|
case '--noverify':
|
||||||
|
verify = false;
|
||||||
|
break;
|
||||||
|
case '--importkey':
|
||||||
|
importkey = true;
|
||||||
|
break;
|
||||||
|
case '--packages':
|
||||||
|
process.argv.shift();
|
||||||
|
pkgDir = process.argv[2];
|
||||||
|
break;
|
||||||
|
case '--deploys':
|
||||||
|
process.argv.shift();
|
||||||
|
deployDir = process.argv[2];
|
||||||
|
break;
|
||||||
|
case '--cfgdir':
|
||||||
|
case '-d':
|
||||||
|
process.argv.shift();
|
||||||
|
cfgDir = process.argv[2];
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
targetVersion = process.argv[2];
|
||||||
|
}
|
||||||
|
process.argv.shift();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (targetVersion === undefined) {
|
||||||
|
targetVersion = 'v' + riotDesktopPackageJson.version;
|
||||||
|
filename = 'element-' + targetVersion + '.tar.gz';
|
||||||
|
url = PACKAGE_URL_PREFIX + targetVersion + '/' + filename;
|
||||||
|
} else if (targetVersion === 'develop') {
|
||||||
|
const buildKiteApiKey = process.env.BUILDKITE_API_KEY;
|
||||||
|
if (buildKiteApiKey === undefined) {
|
||||||
|
console.log("Set BUILDKITE_API_KEY to fetch latest develop version");
|
||||||
|
console.log(
|
||||||
|
"Sorry - Buildkite's API requires authentication to access builds, " +
|
||||||
|
"even if those builds are accessible on the web with no auth.",
|
||||||
|
);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
[filename, url] = await getLatestDevelopUrl(buildKiteApiKey);
|
||||||
|
verify = false; // develop builds aren't signed
|
||||||
|
} else {
|
||||||
|
filename = 'element-' + targetVersion + '.tar.gz';
|
||||||
|
url = PACKAGE_URL_PREFIX + targetVersion + '/' + filename;
|
||||||
|
setVersion = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
const haveGpg = await new Promise((resolve) => {
|
||||||
|
childProcess.execFile('gpg', ['--version'], (error) => {
|
||||||
|
resolve(!error);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
if (importkey) {
|
||||||
|
if (!haveGpg) {
|
||||||
|
console.log("Can't import key without working GPG binary: install GPG and try again");
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
await new Promise((resolve) => {
|
||||||
|
const gpgProc = childProcess.execFile('gpg', ['--import'], (error) => {
|
||||||
|
if (error) {
|
||||||
|
console.log("Failed to import key", error);
|
||||||
|
} else {
|
||||||
|
console.log("Key imported!");
|
||||||
|
}
|
||||||
|
resolve(!error);
|
||||||
|
});
|
||||||
|
needle.get(PUB_KEY_URL).pipe(gpgProc.stdin);
|
||||||
|
});
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cfgDir === undefined) {
|
||||||
|
console.log("No config directory set");
|
||||||
|
console.log("Specify a config directory with --cfgdir or -d");
|
||||||
|
console.log("To build with no config (and no auto-update), pass the empty string (-d '')");
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (verify && !haveGpg) {
|
||||||
|
console.log("No working GPG binary: install GPG or pass --noverify to skip verification");
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
let haveDeploy = false;
|
||||||
|
const expectedDeployDir = path.join(deployDir, path.basename(filename).replace(/\.tar\.gz/, ''));
|
||||||
|
try {
|
||||||
|
await fs.opendir(expectedDeployDir);
|
||||||
|
console.log(expectedDeployDir + "already exists");
|
||||||
|
haveDeploy = true;
|
||||||
|
} catch (e) {
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!haveDeploy) {
|
||||||
|
const outPath = path.join(pkgDir, filename);
|
||||||
|
try {
|
||||||
|
await fsPromises.stat(outPath);
|
||||||
|
console.log("Already have " + filename + ": not redownloading");
|
||||||
|
} catch (e) {
|
||||||
|
try {
|
||||||
|
await downloadToFile(url, outPath);
|
||||||
|
} catch (e) {
|
||||||
|
console.log("Failed to download " + url, e);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (verify) {
|
||||||
|
try {
|
||||||
|
await fsPromises.stat(outPath+'.asc');
|
||||||
|
console.log("Already have " + filename + ".asc: not redownloading");
|
||||||
|
} catch (e) {
|
||||||
|
try {
|
||||||
|
await downloadToFile(url + '.asc', outPath + '.asc');
|
||||||
|
} catch (e) {
|
||||||
|
console.log("Failed to download " + url, e);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await verifyFile(outPath);
|
||||||
|
console.log(outPath + " downloaded and verified");
|
||||||
|
} catch (e) {
|
||||||
|
console.log("Signature verification failed!", e);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.log(outPath + " downloaded but NOT verified");
|
||||||
|
}
|
||||||
|
|
||||||
|
await tar.x({
|
||||||
|
file: outPath,
|
||||||
|
cwd: deployDir,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await fsPromises.stat(ASAR_PATH);
|
||||||
|
console.log(ASAR_PATH + " already present: removing");
|
||||||
|
await fsPromises.unlink(ASAR_PATH);
|
||||||
|
} catch (e) {
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cfgDir.length) {
|
||||||
|
const configJsonSource = path.join(cfgDir, 'config.json');
|
||||||
|
const configJsonDest = path.join(expectedDeployDir, 'config.json');
|
||||||
|
console.log(configJsonSource + ' -> ' + configJsonDest);
|
||||||
|
await fsPromises.copyFile(configJsonSource, configJsonDest);
|
||||||
|
} else {
|
||||||
|
console.log("Skipping config file");
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("Pack " + expectedDeployDir + " -> " + ASAR_PATH);
|
||||||
|
await asar.createPackage(expectedDeployDir, ASAR_PATH);
|
||||||
|
|
||||||
|
if (setVersion) {
|
||||||
|
const semVer = targetVersion.slice(1);
|
||||||
|
console.log("Updating version to " + semVer);
|
||||||
|
await setPackageVersion(semVer);
|
||||||
|
await setDebVersion(semVer);
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("Done!");
|
||||||
|
}
|
||||||
|
|
||||||
|
main().then((ret) => process.exit(ret)).catch(e => process.exit(1));
|
||||||
@ -1,240 +0,0 @@
|
|||||||
#!/usr/bin/env -S npx tsx --resolveJsonModule
|
|
||||||
|
|
||||||
import * as path from "node:path";
|
|
||||||
import { createWriteStream, promises as fs } from "node:fs";
|
|
||||||
import * as childProcess from "node:child_process";
|
|
||||||
import * as tar from "tar";
|
|
||||||
import * as asar from "@electron/asar";
|
|
||||||
import { promises as stream } from "node:stream";
|
|
||||||
|
|
||||||
import riotDesktopPackageJson from "../package.json";
|
|
||||||
import { setPackageVersion } from "./set-version.js";
|
|
||||||
|
|
||||||
const PUB_KEY_URL = "https://packages.riot.im/element-release-key.asc";
|
|
||||||
const PACKAGE_URL_PREFIX = "https://github.com/element-hq/element-web/releases/download/";
|
|
||||||
const DEVELOP_TGZ_URL = "https://develop.element.io/develop.tar.gz";
|
|
||||||
const ASAR_PATH = "webapp.asar";
|
|
||||||
|
|
||||||
async function downloadToFile(url: string, filename: string): Promise<void> {
|
|
||||||
console.log("Downloading " + url + "...");
|
|
||||||
|
|
||||||
try {
|
|
||||||
const resp = await fetch(url);
|
|
||||||
if (!resp.ok) throw new Error(`unexpected response ${resp.statusText}`);
|
|
||||||
if (!resp.body) throw new Error(`unexpected response has no body ${resp.statusText}`);
|
|
||||||
await stream.pipeline(resp.body, createWriteStream(filename));
|
|
||||||
} catch (e) {
|
|
||||||
console.error(e);
|
|
||||||
try {
|
|
||||||
await fs.unlink(filename);
|
|
||||||
} catch {}
|
|
||||||
throw e;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function verifyFile(filename: string): Promise<void> {
|
|
||||||
return new Promise<void>((resolve, reject) => {
|
|
||||||
childProcess.execFile("gpg", ["--verify", filename + ".asc", filename], (error) => {
|
|
||||||
if (error) {
|
|
||||||
reject(error);
|
|
||||||
} else {
|
|
||||||
resolve();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async function main(): Promise<number | undefined> {
|
|
||||||
let verify = true;
|
|
||||||
let importkey = false;
|
|
||||||
let pkgDir = "packages";
|
|
||||||
let deployDir = "deploys";
|
|
||||||
let cfgDir: string | undefined;
|
|
||||||
let targetVersion: string | undefined;
|
|
||||||
let filename: string | undefined;
|
|
||||||
let url: string | undefined;
|
|
||||||
let setVersion = false;
|
|
||||||
|
|
||||||
while (process.argv.length > 2) {
|
|
||||||
switch (process.argv[2]) {
|
|
||||||
case "--noverify":
|
|
||||||
verify = false;
|
|
||||||
break;
|
|
||||||
case "--importkey":
|
|
||||||
importkey = true;
|
|
||||||
break;
|
|
||||||
case "--packages":
|
|
||||||
process.argv.shift();
|
|
||||||
pkgDir = process.argv[2];
|
|
||||||
break;
|
|
||||||
case "--deploys":
|
|
||||||
process.argv.shift();
|
|
||||||
deployDir = process.argv[2];
|
|
||||||
break;
|
|
||||||
case "--cfgdir":
|
|
||||||
case "-d":
|
|
||||||
process.argv.shift();
|
|
||||||
cfgDir = process.argv[2];
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
targetVersion = process.argv[2];
|
|
||||||
}
|
|
||||||
process.argv.shift();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (targetVersion === undefined) {
|
|
||||||
targetVersion = "v" + riotDesktopPackageJson.version;
|
|
||||||
} else if (targetVersion !== "develop") {
|
|
||||||
setVersion = true; // version was specified
|
|
||||||
}
|
|
||||||
|
|
||||||
if (targetVersion === "develop") {
|
|
||||||
filename = "develop.tar.gz";
|
|
||||||
url = DEVELOP_TGZ_URL;
|
|
||||||
verify = false; // develop builds aren't signed
|
|
||||||
} else if (targetVersion.includes("://")) {
|
|
||||||
filename = targetVersion.substring(targetVersion.lastIndexOf("/") + 1);
|
|
||||||
url = targetVersion;
|
|
||||||
verify = false; // manually verified
|
|
||||||
} else {
|
|
||||||
filename = `element-${targetVersion}.tar.gz`;
|
|
||||||
url = PACKAGE_URL_PREFIX + targetVersion + "/" + filename;
|
|
||||||
}
|
|
||||||
|
|
||||||
const haveGpg = await new Promise<boolean>((resolve) => {
|
|
||||||
childProcess.execFile("gpg", ["--version"], (error) => {
|
|
||||||
resolve(!error);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
if (importkey) {
|
|
||||||
if (!haveGpg) {
|
|
||||||
console.log("Can't import key without working GPG binary: install GPG and try again");
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
await new Promise<boolean>((resolve, reject) => {
|
|
||||||
const gpgProc = childProcess.execFile("gpg", ["--import"], (error) => {
|
|
||||||
if (error) {
|
|
||||||
console.log("Failed to import key", error);
|
|
||||||
} else {
|
|
||||||
console.log("Key imported!");
|
|
||||||
}
|
|
||||||
resolve(!error);
|
|
||||||
});
|
|
||||||
fetch(PUB_KEY_URL)
|
|
||||||
.then((resp) => {
|
|
||||||
if (!resp.ok) throw new Error(`unexpected response ${resp.statusText}`);
|
|
||||||
if (!resp.body) throw new Error(`unexpected response has no body ${resp.statusText}`);
|
|
||||||
stream.pipeline(resp.body, gpgProc.stdin!).catch(reject);
|
|
||||||
})
|
|
||||||
.catch(reject);
|
|
||||||
});
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (cfgDir === undefined) {
|
|
||||||
console.log("No config directory set");
|
|
||||||
console.log("Specify a config directory with --cfgdir or -d");
|
|
||||||
console.log("To build with no config (and no auto-update), pass the empty string (-d '')");
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (verify && !haveGpg) {
|
|
||||||
console.log("No working GPG binary: install GPG or pass --noverify to skip verification");
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
let haveDeploy = false;
|
|
||||||
let expectedDeployDir = path.join(deployDir, path.basename(filename).replace(/\.tar\.gz/, ""));
|
|
||||||
try {
|
|
||||||
await fs.opendir(expectedDeployDir);
|
|
||||||
console.log(expectedDeployDir + "already exists");
|
|
||||||
haveDeploy = true;
|
|
||||||
} catch {}
|
|
||||||
|
|
||||||
if (!haveDeploy) {
|
|
||||||
const outPath = path.join(pkgDir, filename);
|
|
||||||
try {
|
|
||||||
await fs.stat(outPath);
|
|
||||||
console.log("Already have " + filename + ": not redownloading");
|
|
||||||
} catch {
|
|
||||||
try {
|
|
||||||
await downloadToFile(url, outPath);
|
|
||||||
} catch (e) {
|
|
||||||
console.log("Failed to download " + url, e);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (verify) {
|
|
||||||
try {
|
|
||||||
await fs.stat(outPath + ".asc");
|
|
||||||
console.log("Already have " + filename + ".asc: not redownloading");
|
|
||||||
} catch {
|
|
||||||
try {
|
|
||||||
await downloadToFile(url + ".asc", outPath + ".asc");
|
|
||||||
} catch (e) {
|
|
||||||
console.log("Failed to download " + url, e);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
await verifyFile(outPath);
|
|
||||||
console.log(outPath + " downloaded and verified");
|
|
||||||
} catch (e) {
|
|
||||||
console.log("Signature verification failed!", e);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
console.log(outPath + " downloaded but NOT verified");
|
|
||||||
}
|
|
||||||
|
|
||||||
await tar.x({
|
|
||||||
file: outPath,
|
|
||||||
cwd: deployDir,
|
|
||||||
onentry: (entry) => {
|
|
||||||
// Find the appropriate extraction path, only needed for `develop` where the dir name is unknown
|
|
||||||
if (entry.type === "Directory" && !path.join(deployDir, entry.path).startsWith(expectedDeployDir)) {
|
|
||||||
expectedDeployDir = path.join(deployDir, entry.path);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
await fs.stat(ASAR_PATH);
|
|
||||||
console.log(ASAR_PATH + " already present: removing");
|
|
||||||
await fs.unlink(ASAR_PATH);
|
|
||||||
} catch {}
|
|
||||||
|
|
||||||
if (cfgDir.length) {
|
|
||||||
const configJsonSource = path.join(cfgDir, "config.json");
|
|
||||||
const configJsonDest = path.join(expectedDeployDir, "config.json");
|
|
||||||
console.log(configJsonSource + " -> " + configJsonDest);
|
|
||||||
await fs.copyFile(configJsonSource, configJsonDest);
|
|
||||||
} else {
|
|
||||||
console.log("Skipping config file");
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log("Pack " + expectedDeployDir + " -> " + ASAR_PATH);
|
|
||||||
await asar.createPackage(expectedDeployDir, ASAR_PATH);
|
|
||||||
|
|
||||||
if (setVersion) {
|
|
||||||
const semVer = (await fs.readFile(path.join(expectedDeployDir, "version"), "utf-8")).trim();
|
|
||||||
console.log("Updating version to " + semVer);
|
|
||||||
await setPackageVersion(semVer);
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log("Done!");
|
|
||||||
}
|
|
||||||
|
|
||||||
main()
|
|
||||||
.then((ret) => {
|
|
||||||
process.exit(ret);
|
|
||||||
})
|
|
||||||
.catch((e) => {
|
|
||||||
console.error(e);
|
|
||||||
process.exit(1);
|
|
||||||
});
|
|
||||||
@ -17,8 +17,7 @@ clone() {
|
|||||||
if [ -n "$branch" ]
|
if [ -n "$branch" ]
|
||||||
then
|
then
|
||||||
echo "Trying to use $org/$repo#$branch"
|
echo "Trying to use $org/$repo#$branch"
|
||||||
# Disable auth prompts: https://serverfault.com/a/665959
|
git clone git://github.com/$org/$repo.git $repo --branch "$branch" --depth 1 && exit 0
|
||||||
GIT_TERMINAL_PROMPT=0 git clone https://github.com/$org/$repo.git $repo --branch "$branch" --depth 1 && exit 0
|
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -1,41 +0,0 @@
|
|||||||
#!/usr/bin/env -S npx tsx
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Script to generate incremental Nightly build versions, based on the latest Nightly build version of that kind.
|
|
||||||
* The version format is YYYYMMDDNN where NN is in case we need to do multiple versions in a day.
|
|
||||||
*
|
|
||||||
* NB. on windows, squirrel will try to parse the version number parts, including this string, into 32-bit integers,
|
|
||||||
* which is fine as long as we only add two digits to the end...
|
|
||||||
*/
|
|
||||||
|
|
||||||
import parseArgs from "minimist";
|
|
||||||
|
|
||||||
const argv = parseArgs<{
|
|
||||||
latest?: string;
|
|
||||||
}>(process.argv.slice(2), {
|
|
||||||
string: ["latest"],
|
|
||||||
});
|
|
||||||
|
|
||||||
function parseVersion(version: string): [Date, number] {
|
|
||||||
const year = parseInt(version.slice(0, 4), 10);
|
|
||||||
const month = parseInt(version.slice(4, 6), 10);
|
|
||||||
const day = parseInt(version.slice(6, 8), 10);
|
|
||||||
const num = parseInt(version.slice(8, 10), 10);
|
|
||||||
return [new Date(year, month - 1, day), num];
|
|
||||||
}
|
|
||||||
|
|
||||||
const [latestDate, latestNum] = argv.latest ? parseVersion(argv.latest) : [];
|
|
||||||
|
|
||||||
const now = new Date();
|
|
||||||
const month = (now.getMonth() + 1).toString().padStart(2, "0");
|
|
||||||
const date = now.getDate().toString().padStart(2, "0");
|
|
||||||
let buildNum = 1;
|
|
||||||
if (latestDate && new Date(latestDate).getDate().toString().padStart(2, "0") === date) {
|
|
||||||
buildNum = latestNum! + 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (buildNum > 99) {
|
|
||||||
throw new Error("Maximum number of Nightlies exceeded on this day.");
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(now.getFullYear() + month + date + buildNum.toString().padStart(2, "0"));
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user