Upstream/bitwarden-browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-02 08:40:08 +01:00
Code Issues Projects Releases Wiki Activity

Export to stdout (#152)

Browse Source 
* describe file-saving and add helper to write to stdout if appropriate

* allow writing attachments to stdout

* allow writing export to stdout

* add help texts for export and get
This commit is contained in:
Andreas Schneider 2020-08-25 20:24:43 +02:00 committed by GitHub
parent 9f72e0e316
commit f2530c133e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 52 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/commands/export.command.ts
View File

@ -35,27 +35,24 @@ export class ExportCommand {
if (cmd.organizationid != null && !Utils.isGuid(cmd.organizationid)) {
return Response.error('`' + cmd.organizationid + '` is not a GUID.');
}
let csv: string = null;
let exportContent: string = null;
try {
csv = cmd.organizationid != null ?
exportContent = cmd.organizationid != null ?
await this.exportService.getOrganizationExport(cmd.organizationid, format) :
await this.exportService.getExport(format);
} catch (e) {
return Response.error(e);
}
return await this.saveFile(csv, cmd, format);
return await this.saveFile(exportContent, cmd, format);
} else {
return Response.error('Invalid master password.');
}
}
async saveFile(csv: string, cmd: program.Command, format: string): Promise<Response> {
async saveFile(exportContent: string, cmd: program.Command, format: string): Promise<Response> {
try {
const filePath = await CliUtils.saveFile(csv, cmd.output,
this.exportService.getFileName(cmd.organizationid != null ? 'org' : null, format));
const res = new MessageResponse('Saved ' + filePath, null);
res.raw = filePath;
return Response.success(res);
const fileName = this.exportService.getFileName(cmd.organizationid != null ? 'org' : null, format);
return await CliUtils.saveResultToFile(exportContent, cmd.output, fileName);
} catch (e) {
return Response.error(e.toString());
}

5
src/commands/get.command.ts
View File

@ -283,10 +283,7 @@ export class GetCommand {
const key = attachments[0].key != null ? attachments[0].key :
await this.cryptoService.getOrgKey(cipher.organizationId);
const decBuf = await this.cryptoService.decryptFromBytes(buf, key);
const filePath = await CliUtils.saveFile(Buffer.from(decBuf), cmd.output, attachments[0].fileName);
const res = new MessageResponse('Saved ' + filePath, null);
res.raw = filePath;
return Response.success(res);
return await CliUtils.saveResultToFile(Buffer.from(decBuf), cmd.output, attachments[0].fileName);
} catch (e) {
if (typeof (e) === 'string') {
return Response.error(e);

6
src/program.ts
View File

@ -304,6 +304,9 @@ export class Program extends BaseProgram {
writeLn('');
writeLn(' Search term or object\'s globally unique `id`.');
writeLn('');
writeLn(' If raw output is specified and no output filename or directory is given for');
writeLn(' an attachment query, the attachment content is written to stdout.');
writeLn('');
writeLn(' Examples:');
writeLn('');
writeLn(' bw get item 99ee88d2-6046-4ea7-92c2-acac464b1412');
@ -543,6 +546,9 @@ export class Program extends BaseProgram {
writeLn('');
writeLn(' Valid formats are `csv` and `json`. Default format is `csv`.');
writeLn('');
writeLn(' If raw output is specified and no output filename or directory is given, the');
writeLn(' result is written to stdout.');
writeLn('');
writeLn(' Examples:');
writeLn('');
writeLn(' bw export');

39
src/utils.ts
View File

@ -1,6 +1,9 @@
import * as fs from 'fs';
import * as path from 'path';
import { Response } from 'jslib/cli/models/response';
import { MessageResponse } from 'jslib/cli/models/response/messageResponse';
import { Organization } from 'jslib/models/domain/organization';
import { CollectionView } from 'jslib/models/view/collectionView';
import { FolderView } from 'jslib/models/view/folderView';
@ -39,6 +42,16 @@ export class CliUtils {
});
}
/**
* Save the given data to a file and determine the target file if necessary.
* If output is non-empty, it is used as target filename. Otherwise the target filename is
* built from the current working directory and the given defaultFileName.
*
* @param data to be written to the file.
* @param output file to write to or empty to choose automatically.
* @param defaultFileName to use when no explicit output filename is given.
* @return the chosen output file.
*/
static saveFile(data: string | Buffer, output: string, defaultFileName: string) {
let p: string = null;
let mkdir = false;
@ -76,6 +89,32 @@ export class CliUtils {
});
}
/**
* Process the given data and write it to a file if possible. If the user requested RAW output and
* no output name is given, the file is directly written to stdout. The resulting Response contains
* an otherwise empty message then to prevent writing other information to stdout.
*
* If an output is given or no RAW output is requested, the rules from [saveFile] apply.
*
* @param data to be written to the file or stdout.
* @param output file to write to or empty to choose automatically.
* @param defaultFileName to use when no explicit output filename is given.
* @return an empty [Response] if written to stdout or a [Response] with the chosen output file otherwise.
*/
static async saveResultToFile(data: string | Buffer, output: string, defaultFileName: string) {
if ((output == null || output === '') && process.env.BW_RAW === 'true') {
// No output is given and the user expects raw output. Since the command result is about content,
// we directly return the command result to stdout (and suppress further messages).
process.stdout.write(data);
return Response.success();
}
const filePath = await this.saveFile(data, output, defaultFileName);
const res = new MessageResponse('Saved ' + filePath, null);
res.raw = filePath;
return Response.success(res);
}
static readStdin(): Promise<string> {
return new Promise((resolve, reject) => {
let input: string = '';