2021-05-14 11:29:06 +02:00
|
|
|
import shim from '@joplin/lib/shim';
|
|
|
|
import Logger from '@joplin/lib/Logger';
|
|
|
|
import { _ } from '@joplin/lib/locale';
|
|
|
|
import bridge from './services/bridge';
|
|
|
|
import KvStore from '@joplin/lib/services/KvStore';
|
2020-11-07 17:59:37 +02:00
|
|
|
const { fileExtension } = require('@joplin/lib/path-utils');
|
2021-05-14 11:29:06 +02:00
|
|
|
const ArrayUtils = require('@joplin/lib/ArrayUtils');
|
2018-03-14 19:23:19 +02:00
|
|
|
const packageInfo = require('./packageInfo.js');
|
|
|
|
const compareVersions = require('compare-versions');
|
2018-01-31 00:35:50 +02:00
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
const logger = Logger.create('checkForUpdates');
|
|
|
|
|
2018-01-31 00:35:50 +02:00
|
|
|
let checkInBackground_ = false;
|
2018-02-16 01:05:04 +02:00
|
|
|
let isCheckingForUpdate_ = false;
|
2018-01-31 00:35:50 +02:00
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
interface CheckForUpdateOptions {
|
|
|
|
includePreReleases?: boolean;
|
2018-02-16 01:05:04 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
function onCheckStarted() {
|
2021-05-14 11:29:06 +02:00
|
|
|
logger.info('Starting...');
|
2018-02-16 01:05:04 +02:00
|
|
|
isCheckingForUpdate_ = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
function onCheckEnded() {
|
2021-05-14 11:29:06 +02:00
|
|
|
logger.info('Done.');
|
2018-02-16 01:05:04 +02:00
|
|
|
isCheckingForUpdate_ = false;
|
|
|
|
}
|
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
function getMajorMinorTagName(tagName: string) {
|
2021-05-04 15:53:44 +02:00
|
|
|
const s = tagName.split('.');
|
|
|
|
s.pop();
|
|
|
|
return s.join('.');
|
|
|
|
}
|
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
async function fetchLatestRelease(options: CheckForUpdateOptions) {
|
2019-01-12 01:40:05 +02:00
|
|
|
options = Object.assign({}, { includePreReleases: false }, options);
|
2018-02-16 20:08:02 +02:00
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
const response = await shim.fetch('https://api.github.com/repos/laurent22/joplin/releases');
|
2021-05-04 15:53:44 +02:00
|
|
|
|
|
|
|
if (!response.ok) {
|
|
|
|
const responseText = await response.text();
|
|
|
|
throw new Error(`Cannot get latest release info: ${responseText.substr(0,500)}`);
|
|
|
|
}
|
|
|
|
|
|
|
|
const releases = await response.json();
|
|
|
|
if (!releases.length) throw new Error('Cannot get latest release info (JSON)');
|
|
|
|
|
|
|
|
let release = null;
|
2019-01-12 01:40:05 +02:00
|
|
|
|
|
|
|
if (options.includePreReleases) {
|
2021-05-04 15:53:44 +02:00
|
|
|
release = releases[0];
|
|
|
|
} else {
|
|
|
|
for (const r of releases) {
|
|
|
|
if (!r.prerelease) {
|
|
|
|
release = r;
|
|
|
|
break;
|
|
|
|
}
|
2019-01-12 01:40:05 +02:00
|
|
|
}
|
2021-05-04 15:53:44 +02:00
|
|
|
}
|
2019-01-12 01:40:05 +02:00
|
|
|
|
2021-05-04 15:53:44 +02:00
|
|
|
if (!release) throw new Error('Could not get tag name');
|
2018-02-16 20:08:02 +02:00
|
|
|
|
2021-05-04 15:53:44 +02:00
|
|
|
const version = release.tag_name.substr(1);
|
|
|
|
|
|
|
|
// We concatenate all the release notes of the major/minor versions
|
|
|
|
// corresponding to the latest version. For example, if the latest version
|
|
|
|
// is 1.8.3, we concatenate all the 1.8.x versions. This is so that no
|
|
|
|
// matter from which version you upgrade, you always see the full changes,
|
|
|
|
// with the latest changes being on top.
|
|
|
|
|
|
|
|
const fullReleaseNotes = [];
|
|
|
|
const majorMinorTagName = getMajorMinorTagName(release.tag_name);
|
2019-01-12 01:40:05 +02:00
|
|
|
|
2021-05-04 15:53:44 +02:00
|
|
|
for (const release of releases) {
|
|
|
|
if (getMajorMinorTagName(release.tag_name) === majorMinorTagName) {
|
|
|
|
fullReleaseNotes.push(release.body.trim());
|
|
|
|
}
|
2019-01-12 01:40:05 +02:00
|
|
|
}
|
2019-07-30 09:35:42 +02:00
|
|
|
|
2018-03-14 19:23:19 +02:00
|
|
|
let downloadUrl = null;
|
|
|
|
const platform = process.platform;
|
2021-05-04 15:53:44 +02:00
|
|
|
for (let i = 0; i < release.assets.length; i++) {
|
|
|
|
const asset = release.assets[i];
|
2018-03-14 19:23:19 +02:00
|
|
|
let found = false;
|
2018-05-14 12:08:33 +02:00
|
|
|
const ext = fileExtension(asset.name);
|
|
|
|
if (platform === 'win32' && ext === 'exe') {
|
|
|
|
if (shim.isPortable()) {
|
|
|
|
found = asset.name == 'JoplinPortable.exe';
|
|
|
|
} else {
|
|
|
|
found = !!asset.name.match(/^Joplin-Setup-[\d.]+\.exe$/);
|
|
|
|
}
|
|
|
|
} else if (platform === 'darwin' && ext === 'dmg') {
|
2018-03-14 19:23:19 +02:00
|
|
|
found = true;
|
2018-05-14 12:08:33 +02:00
|
|
|
} else if (platform === 'linux' && ext === '.AppImage') {
|
2018-03-14 19:23:19 +02:00
|
|
|
found = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (found) {
|
|
|
|
downloadUrl = asset.browser_download_url;
|
|
|
|
break;
|
|
|
|
}
|
2018-02-06 15:11:59 +02:00
|
|
|
}
|
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
function cleanUpReleaseNotes(releaseNotes: string[]) {
|
2021-05-04 15:53:44 +02:00
|
|
|
const lines = releaseNotes.join('\n\n* * *\n\n').split('\n');
|
|
|
|
const output = [];
|
|
|
|
for (const line of lines) {
|
|
|
|
const r = line
|
|
|
|
.replace(/\(#.* by .*\)/g, '') // Removes issue numbers and names - (#3157 by [@user](https://github.com/user))
|
|
|
|
.replace(/\([0-9a-z]{7}\)/g, '') // Removes commits - "sync state or data (a6caa35)"
|
|
|
|
.replace(/\(#[0-9]+\)/g, '') // Removes issue numbers - "(#4727)"
|
|
|
|
.replace(/ {2}/g, ' ')
|
|
|
|
.trim();
|
|
|
|
|
|
|
|
output.push(r);
|
|
|
|
}
|
|
|
|
return output.join('\n');
|
|
|
|
}
|
|
|
|
|
2018-03-14 19:23:19 +02:00
|
|
|
return {
|
|
|
|
version: version,
|
|
|
|
downloadUrl: downloadUrl,
|
2021-05-04 15:53:44 +02:00
|
|
|
notes: cleanUpReleaseNotes(fullReleaseNotes),
|
|
|
|
pageUrl: release.html_url,
|
|
|
|
prerelease: release.prerelease,
|
2018-03-14 19:23:19 +02:00
|
|
|
};
|
|
|
|
}
|
2018-01-31 00:35:50 +02:00
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
function truncateText(text: string, length: number) {
|
2019-10-12 00:44:58 +02:00
|
|
|
let truncated = text.substring(0, length);
|
|
|
|
const lastNewLine = truncated.lastIndexOf('\n');
|
|
|
|
// Cut off at a line break unless we'd be cutting off half the text
|
|
|
|
if (lastNewLine > length / 2) {
|
|
|
|
truncated = `${truncated.substring(0, lastNewLine)}\n...`;
|
|
|
|
} else {
|
|
|
|
truncated = `${truncated.trim()}...`;
|
|
|
|
}
|
|
|
|
return truncated;
|
|
|
|
}
|
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
async function getSkippedVersions(): Promise<string[]> {
|
|
|
|
const r = await KvStore.instance().value<string>('updateCheck::skippedVersions');
|
|
|
|
return r ? JSON.parse(r) : [];
|
|
|
|
}
|
|
|
|
|
|
|
|
async function isSkippedVersion(v: string): Promise<boolean> {
|
|
|
|
const versions = await getSkippedVersions();
|
|
|
|
return versions.includes(v);
|
|
|
|
}
|
|
|
|
|
|
|
|
async function addSkippedVersion(s: string) {
|
|
|
|
let versions = await getSkippedVersions();
|
|
|
|
versions.push(s);
|
|
|
|
versions = ArrayUtils.unique(versions);
|
|
|
|
await KvStore.instance().setValue('updateCheck::skippedVersions', JSON.stringify(versions));
|
|
|
|
}
|
|
|
|
|
|
|
|
export default async function checkForUpdates(inBackground: boolean, parentWindow: any, options: CheckForUpdateOptions) {
|
2018-02-16 01:05:04 +02:00
|
|
|
if (isCheckingForUpdate_) {
|
2021-05-14 11:29:06 +02:00
|
|
|
logger.info('Skipping check because it is already running');
|
2018-02-16 01:05:04 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
onCheckStarted();
|
|
|
|
|
2018-01-31 00:35:50 +02:00
|
|
|
checkInBackground_ = inBackground;
|
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
logger.info(`Checking with options ${JSON.stringify(options)}`);
|
|
|
|
|
|
|
|
try {
|
|
|
|
const release = await fetchLatestRelease(options);
|
2019-01-12 01:40:05 +02:00
|
|
|
|
2021-05-14 11:29:06 +02:00
|
|
|
logger.info(`Current version: ${packageInfo.version}`);
|
|
|
|
logger.info(`Latest version: ${release.version}`);
|
|
|
|
logger.info('Is Pre-release:', release.prerelease);
|
2018-05-14 13:18:00 +02:00
|
|
|
|
2018-03-14 19:23:19 +02:00
|
|
|
if (compareVersions(release.version, packageInfo.version) <= 0) {
|
2020-03-14 01:57:34 +02:00
|
|
|
if (!checkInBackground_) {
|
2021-05-14 11:29:06 +02:00
|
|
|
await bridge().showMessageBox(_('Current version is up-to-date.'));
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
const shouldSkip = checkInBackground_ && await isSkippedVersion(release.version);
|
|
|
|
|
|
|
|
if (shouldSkip) {
|
|
|
|
logger.info('Not displaying notification because version has been skipped');
|
|
|
|
} else {
|
|
|
|
const fullReleaseNotes = release.notes.trim() ? `\n\n${release.notes.trim()}` : '';
|
|
|
|
const MAX_RELEASE_NOTES_LENGTH = 1000;
|
|
|
|
const truncateReleaseNotes = fullReleaseNotes.length > MAX_RELEASE_NOTES_LENGTH;
|
|
|
|
const releaseNotes = truncateReleaseNotes ? truncateText(fullReleaseNotes, MAX_RELEASE_NOTES_LENGTH) : fullReleaseNotes;
|
|
|
|
|
|
|
|
const newVersionString = release.prerelease ? _('%s (pre-release)', release.version) : release.version;
|
|
|
|
|
|
|
|
const buttonIndex = await bridge().showMessageBox(parentWindow, {
|
2020-03-14 01:57:34 +02:00
|
|
|
type: 'info',
|
2021-05-14 11:29:06 +02:00
|
|
|
message: `${_('An update is available, do you want to download it now?')}`,
|
|
|
|
detail: `${_('Your version: %s', packageInfo.version)}\n${_('New version: %s', newVersionString)}${releaseNotes}`,
|
|
|
|
buttons: [_('Download'), _('Skip this version'), _('Full changelog'), _('Cancel')],
|
|
|
|
cancelId: 3,
|
2020-03-14 01:57:34 +02:00
|
|
|
});
|
2021-05-14 11:29:06 +02:00
|
|
|
|
|
|
|
if (buttonIndex === 0) {
|
|
|
|
bridge().openExternal(release.downloadUrl ? release.downloadUrl : release.pageUrl);
|
|
|
|
} else if (buttonIndex === 1) {
|
|
|
|
await addSkippedVersion(release.version);
|
|
|
|
} else if (buttonIndex === 2) {
|
|
|
|
bridge().openExternal('https://joplinapp.org/changelog/');
|
|
|
|
}
|
2020-03-14 01:57:34 +02:00
|
|
|
}
|
2018-03-14 19:23:19 +02:00
|
|
|
}
|
2021-05-14 11:29:06 +02:00
|
|
|
} catch (error) {
|
|
|
|
logger.error(error);
|
|
|
|
if (!checkInBackground_) await bridge().showErrorMessageBox(error.message);
|
|
|
|
} finally {
|
2018-02-16 01:05:04 +02:00
|
|
|
onCheckEnded();
|
2021-05-14 11:29:06 +02:00
|
|
|
}
|
2018-01-31 00:35:50 +02:00
|
|
|
}
|