matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-07 23:02:56 +03:00
Code Activity

Use SAS emoji data from matrix-doc

Browse Source 
Fixes https://github.com/vector-im/element-web/issues/14947

Much like element-web's Jitsi wrapper build steps, this downloads the emoji JSON at build time to ensure it gets reasonably updated. In the future, the spec might want to consider publishing a dedicated i18n package on npm for this, however this is fine for now. We download rather than copy/paste to ensure we always have an updated copy.
This commit is contained in:
Travis Ralston
2020-08-17 15:35:03 -06:00
parent 64cdd73b93
commit 5d95398621
7 changed files with 123 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -13,6 +13,7 @@ out
/dist
/lib
/specbuild
/res
# version file and tarball created by `npm pack` / `yarn pack`
/git-revision.txt

5
package.json
View File

@@ -7,7 +7,8 @@
"start": "echo THIS IS FOR LEGACY PURPOSES ONLY. && babel src -w -s -d lib --verbose --extensions \".ts,.js\"",
"dist": "echo 'This is for the release script so it can make assets (browser bundle).' && yarn build",
"clean": "rimraf lib dist",
"build": "yarn clean && git rev-parse HEAD > git-revision.txt && yarn build:compile && yarn build:compile-browser && yarn build:minify-browser && yarn build:types",
"build": "yarn clean && git rev-parse HEAD > git-revision.txt && yarn build:spec-i18n && yarn build:compile && yarn build:compile-browser && yarn build:minify-browser && yarn build:types",
"build:spec-i18n": "node scripts/spec-i18n.js",
"build:types": "tsc --emitDeclarationOnly",
"build:compile": "babel -d lib --verbose --extensions \".ts,.js\" src",
"build:compile-browser": "mkdirp dist && browserify -d src/browser-index.js -p [ tsify -p ./tsconfig.json ] -t [ babelify --sourceMaps=inline --presets [ @babel/preset-env @babel/preset-typescript ] ] | exorcist dist/browser-matrix.js.map > dist/browser-matrix.js",
@@ -37,6 +38,7 @@
"dist",
"lib",
"src",
"res",
"git-revision.txt",
"CHANGELOG.md",
"CONTRIBUTING.rst",
@@ -52,6 +54,7 @@
"bs58": "^4.0.1",
"content-type": "^1.0.2",
"loglevel": "^1.6.4",
"node-fetch": "^2.6.0",
"qs": "^6.5.2",
"request": "^2.88.0",
"unhomoglyph": "^1.0.2"

37
scripts/spec-i18n.js Normal file
View File

@@ -0,0 +1,37 @@
/*
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.
*/
// This is a JS script to remove OS dependencies on downloading a file. Sorry.
const fs = require("fs");
const path = require("path");
const mkdirp = require("mkdirp");
const fetch = require("node-fetch");
console.log("Making res directory");
mkdirp.sync("res");
// curl -s https://github.com/matrix-org/matrix-doc/raw/master/data-definitions/sas-emoji.json > ./res/sas-emoji.json
console.log("Downloading sas-emoji.json");
const fname = path.join("res", "sas-emoji.json");
fetch("https://github.com/matrix-org/matrix-doc/raw/master/data-definitions/sas-emoji.json").then(res => {
const stream = fs.createWriteStream(fname);
return new Promise((resolve, reject) => {
res.body.pipe(stream);
res.body.on('error', err => reject(err));
res.body.on('finish', () => resolve());
});
}).then(() => console.log('Done with sas-emoji.json download'));

70
src/crypto/verification/SAS.js
View File

@@ -29,6 +29,7 @@ import {
newUserCancelledError,
} from './Error';
import {logger} from '../../logger';
import {SASEmojiV1} from "./SASEmojiV1";
const START_TYPE = "m.key.verification.start";
@@ -64,73 +65,6 @@ function generateDecimalSas(sasBytes) {
];
}
const emojiMapping = [
["🐶", "dog"], // 0
["🐱", "cat"], // 1
["🦁", "lion"], // 2
["🐎", "horse"], // 3
["🦄", "unicorn"], // 4
["🐷", "pig"], // 5
["🐘", "elephant"], // 6
["🐰", "rabbit"], // 7
["🐼", "panda"], // 8
["🐓", "rooster"], // 9
["🐧", "penguin"], // 10
["🐢", "turtle"], // 11
["🐟", "fish"], // 12
["🐙", "octopus"], // 13
["🦋", "butterfly"], // 14
["🌷", "flower"], // 15
["🌳", "tree"], // 16
["🌵", "cactus"], // 17
["🍄", "mushroom"], // 18
["🌏", "globe"], // 19
["🌙", "moon"], // 20
["☁️", "cloud"], // 21
["🔥", "fire"], // 22
["🍌", "banana"], // 23
["🍎", "apple"], // 24
["🍓", "strawberry"], // 25
["🌽", "corn"], // 26
["🍕", "pizza"], // 27
["🎂", "cake"], // 28
["❤️", "heart"], // 29
["🙂", "smiley"], // 30
["🤖", "robot"], // 31
["🎩", "hat"], // 32
["👓", "glasses"], // 33
["🔧", "spanner"], // 34
["🎅", "santa"], // 35
["👍", "thumbs up"], // 36
["☂️", "umbrella"], // 37
["⌛", "hourglass"], // 38
["⏰", "clock"], // 39
["🎁", "gift"], // 40
["💡", "light bulb"], // 41
["📕", "book"], // 42
["✏️", "pencil"], // 43
["📎", "paperclip"], // 44
["✂️", "scissors"], // 45
["🔒", "lock"], // 46
["🔑", "key"], // 47
["🔨", "hammer"], // 48
["☎️", "telephone"], // 49
["🏁", "flag"], // 50
["🚂", "train"], // 51
["🚲", "bicycle"], // 52
["✈️", "aeroplane"], // 53
["🚀", "rocket"], // 54
["🏆", "trophy"], // 55
["⚽", "ball"], // 56
["🎸", "guitar"], // 57
["🎺", "trumpet"], // 58
["🔔", "bell"], // 59
["⚓️", "anchor"], // 60
["🎧", "headphones"], // 61
["📁", "folder"], // 62
["📌", "pin"], // 63
];
function generateEmojiSas(sasBytes) {
const emojis = [
// just like base64 encoding
@@ -143,7 +77,7 @@ function generateEmojiSas(sasBytes) {
(sasBytes[4] & 0xf) << 2 | sasBytes[5] >> 6,
];
return emojis.map((num) => emojiMapping[num]);
return emojis.map((num) => SASEmojiV1.getEmojiPair(num));
}
const sasGenerators = {

73
src/crypto/verification/SASEmojiV1.ts Normal file
View File

@@ -0,0 +1,73 @@
/*
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.
*/
import v1Emoji from "../../../res/sas-emoji.json";
export interface ITranslations {
[languageCode: string]: string;
}
/**
* Some useful utilities for accessing the SAS v1 emoji data.
*/
export class SASEmojiV1 {
public static getEmojiPair(index: number): [string, string] {
return [SASEmojiV1.getEmoji(index), SASEmojiV1.getName(index).toLowerCase()]; // .toLowerCase() for compat
}
public static getEmoji(index: number): string {
return v1Emoji[index].emoji;
}
public static getName(index: number): string {
return v1Emoji[index].description;
}
public static getTranslations(index: number): ITranslations {
return v1Emoji[index].translated_descriptions;
}
public static getNameFor(emoji: string): string {
for (const e of v1Emoji) {
if (e.emoji === emoji) {
return e.description;
}
}
throw new Error("Emoji not found");
}
public static getNumberFor(emoji: string): number {
for (const e of v1Emoji) {
if (e.emoji === emoji) {
return e.number;
}
}
throw new Error("Emoji not found");
}
public static getTranslationsFor(emoji: string): ITranslations {
for (const e of v1Emoji) {
if (e.emoji === emoji) {
return e.translated_descriptions;
}
}
throw new Error("Emoji not found");
}
public static getAllEmoji(): string[] {
return v1Emoji.map(e => e.emoji);
}
}

1
tsconfig.json
View File

@@ -10,6 +10,7 @@
"sourceMap": true,
"outDir": "./lib",
"declaration": true,
"resolveJsonModule": true,
"types": [
"node"
]

5
yarn.lock
View File

@@ -4930,6 +4930,11 @@ node-dir@^0.1.10:
dependencies:
minimatch "^3.0.2"
node-fetch@^2.6.0:
version "2.6.0"
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
node-int64@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b"