import 'dart:async'; import 'package:after_layout/after_layout.dart'; import 'package:dartssh2/dartssh2.dart'; import 'package:flutter/material.dart'; import 'package:flutter_gen/gen_l10n/l10n.dart'; import 'package:toolbox/core/extension/context.dart'; import 'package:toolbox/core/extension/sftpfile.dart'; import 'package:toolbox/data/res/logger.dart'; import 'package:toolbox/data/res/misc.dart'; import 'package:toolbox/data/store/history.dart'; import 'package:toolbox/view/widget/round_rect_card.dart'; import '../../../core/extension/numx.dart'; import '../../../core/extension/stringx.dart'; import '../../../core/route.dart'; import '../../../core/utils/misc.dart'; import '../../../core/utils/platform.dart'; import '../../../data/model/server/server_private_info.dart'; import '../../../data/model/sftp/absolute_path.dart'; import '../../../data/model/sftp/browser_status.dart'; import '../../../data/model/sftp/req.dart'; import '../../../data/provider/server.dart'; import '../../../data/provider/sftp.dart'; import '../../../data/res/path.dart'; import '../../../data/res/ui.dart'; import '../../../data/store/setting.dart'; import '../../../locator.dart'; import '../../widget/custom_appbar.dart'; import '../../widget/fade_in.dart'; import '../../widget/input_field.dart'; import '../../widget/two_line_text.dart'; class SftpPage extends StatefulWidget { final ServerPrivateInfo spi; final String? initPath; final bool selectPath; const SftpPage({ Key? key, required this.spi, required this.selectPath, this.initPath, }) : super(key: key); @override _SftpPageState createState() => _SftpPageState(); } class _SftpPageState extends State with AfterLayoutMixin { final SftpBrowserStatus _status = SftpBrowserStatus(); final _sftp = locator(); final _history = locator(); final _setting = locator(); late S _s; SSHClient? _client; @override void didChangeDependencies() { super.didChangeDependencies(); _s = S.of(context)!; } @override void initState() { super.initState(); final serverProvider = locator(); _client = serverProvider.servers[widget.spi.id]?.client; } @override Widget build(BuildContext context) { return Scaffold( appBar: CustomAppBar( leading: IconButton( icon: const BackButtonIcon(), onPressed: () { if (_status.path != null) { _status.path!.update('/'); } context.pop(); }, ), title: TwoLineText(up: 'SFTP', down: widget.spi.name), actions: [ IconButton( icon: const Icon(Icons.downloading), onPressed: () => AppRoute.sftpMission().go(context), ), ], ), body: _buildBody(), bottomNavigationBar: _buildBottom(), ); } Widget _buildBody() { return WillPopScope( onWillPop: () async { if (_status.path == null || _status.path?.path == '/') { return true; } await _backward(); return false; }, child: _buildFileView(), ); } Widget _buildBottom() { final children = widget.selectPath ? [ IconButton( onPressed: () => context.pop(_status.path?.path), icon: const Icon(Icons.done)) ] : [ IconButton( padding: const EdgeInsets.all(0), onPressed: () async { await _backward(); }, icon: const Icon(Icons.arrow_back), ), _buildAddBtn(), _buildGotoBtn(), _buildUploadBtn(), ]; if (isDesktop) children.add(_buildRefreshBtn()); return SafeArea( child: Container( padding: const EdgeInsets.fromLTRB(11, 7, 11, 11), child: Column( mainAxisSize: MainAxisSize.min, children: [ (_status.path?.path ?? _s.loadingFiles).omitStartStr(), Row( mainAxisAlignment: MainAxisAlignment.spaceAround, children: children, ) ], ), ), ); } Widget _buildUploadBtn() { return IconButton( onPressed: () async { final idx = await context.showRoundDialog( child: Column( mainAxisSize: MainAxisSize.min, children: [ ListTile( leading: const Icon(Icons.open_in_new), title: Text(_s.system), onTap: () => context.pop(1), ), ListTile( leading: const Icon(Icons.folder), title: Text(_s.inner), onTap: () => context.pop(0), ), ], )); final path = await () async { switch (idx) { case 0: return await AppRoute.localStorage(isPickFile: true) .go(context); case 1: return await pickOneFile(); default: return null; } }(); if (path == null) { return; } final remotePath = _status.path?.path; if (remotePath == null) { context.showSnackBar('remote path is null'); return; } _sftp.add( SftpReq( widget.spi, '$remotePath/${path.split('/').last}', path, SftpReqType.upload, ), ); }, icon: const Icon(Icons.upload_file)); } Widget _buildAddBtn() { return IconButton( onPressed: (() => context.showRoundDialog( child: Column( mainAxisSize: MainAxisSize.min, children: [ ListTile( leading: const Icon(Icons.folder), title: Text(_s.createFolder), onTap: () => _mkdir(context)), ListTile( leading: const Icon(Icons.insert_drive_file), title: Text(_s.createFile), onTap: () => _newFile(context)), ], ), )), icon: const Icon(Icons.add), ); } Widget _buildGotoBtn() { return IconButton( padding: const EdgeInsets.all(0), onPressed: () async { final p = await context.showRoundDialog( title: Text(_s.goto), child: Autocomplete( optionsBuilder: (val) { if (!_setting.recordHistory.fetch()) { return []; } return _history.sftpPath.all.where( (element) => element.contains(val.text), ); }, fieldViewBuilder: (_, controller, node, __) { return Input( autoFocus: true, icon: Icons.abc, label: _s.path, node: node, controller: controller, onSubmitted: (value) => context.pop(value), ); }, ), ); if (p == null || p.isEmpty) { return; } _status.path?.update(p); final suc = await _listDir(path: p); if (suc && _setting.recordHistory.fetch()) _history.sftpPath.add(p); }, icon: const Icon(Icons.gps_fixed), ); } Widget _buildRefreshBtn() { return IconButton( onPressed: () => _listDir(), icon: const Icon(Icons.refresh), ); } Widget _buildFileView() { if (_status.files == null) { return centerLoading; } if (_status.files!.isEmpty) { return const Center( child: Text('~'), ); } return RefreshIndicator( child: FadeIn( key: Key(widget.spi.name + _status.path!.path), child: ListView.builder( itemCount: _status.files!.length, padding: const EdgeInsets.symmetric(horizontal: 7, vertical: 3), itemBuilder: (_, index) => _buildItem(_status.files![index]), ), ), onRefresh: () => _listDir(), ); } Widget _buildItem(SftpName file) { final isDir = file.attr.isDirectory; final trailing = Text( '${getTime(file.attr.modifyTime)}\n${file.attr.mode?.str ?? ''}', style: grey, textAlign: TextAlign.right, ); return RoundRectCard(ListTile( leading: Icon(isDir ? Icons.folder : Icons.insert_drive_file), title: Text(file.filename), trailing: trailing, subtitle: isDir ? null : Text( (file.attr.size ?? 0).convertBytes, style: grey, ), onTap: () { if (isDir) { _status.path?.update(file.filename); _listDir(path: _status.path?.path); } else { _onItemPress(context, file, true); } }, onLongPress: () => _onItemPress(context, file, !isDir), )); } void _onItemPress(BuildContext context, SftpName file, bool notDir) { final children = [ ListTile( leading: const Icon(Icons.delete), title: Text(_s.delete), onTap: () => _delete(context, file), ), ListTile( leading: const Icon(Icons.abc), title: Text(_s.rename), onTap: () => _rename(context, file), ), ]; if (notDir) { children.addAll([ ListTile( leading: const Icon(Icons.edit), title: Text(_s.edit), onTap: () => _edit(context, file), ), ListTile( leading: const Icon(Icons.download), title: Text(_s.download), onTap: () => _download(context, file), ), // Only show decompress option when the file is a compressed file if (_canDecompress(file.filename)) ListTile( leading: const Icon(Icons.folder_zip), title: Text(_s.decompress), onTap: () => _decompress(context, file), ), ]); } context.showRoundDialog( child: Column( mainAxisSize: MainAxisSize.min, children: children, ), ); } Future _edit(BuildContext context, SftpName name) async { final size = name.attr.size; if (size == null || size > editorMaxSize) { context.showSnackBar(_s.fileTooLarge( name.filename, size ?? 0, editorMaxSize, )); return; } context.pop(); final remotePath = _getRemotePath(name); final localPath = await _getLocalPath(remotePath); final completer = Completer(); final req = SftpReq( widget.spi, remotePath, localPath, SftpReqType.download, ); _sftp.add(req, completer: completer); context.showLoadingDialog(); await completer.future; context.pop(); final result = await AppRoute.editor(path: localPath).go(context); if (result != null && result) { _sftp.add(SftpReq(req.spi, remotePath, localPath, SftpReqType.upload)); context.showSnackBar(_s.added2List); } } void _download(BuildContext context, SftpName name) { context.showRoundDialog( title: Text(_s.attention), child: Text('${_s.dl2Local(name.filename)}\n${_s.keepForeground}'), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.cancel), ), TextButton( onPressed: () async { context.pop(); final remotePath = _getRemotePath(name); _sftp.add( SftpReq( widget.spi, remotePath, await _getLocalPath(remotePath), SftpReqType.download, ), ); context.pop(); }, child: Text(_s.download), ) ], ); } void _delete(BuildContext context, SftpName file) { context.pop(); final isDir = file.attr.isDirectory; final useRmrf = _setting.sftpRmrfDir.fetch(); final dirText = (isDir && !useRmrf) ? '\n${_s.sureDirEmpty}' : ''; final text = '${_s.sureDelete(file.filename)}$dirText'; final child = Text(text); context.showRoundDialog( child: child, title: Text(_s.attention), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.cancel), ), TextButton( onPressed: () async { context.pop(); context.showLoadingDialog(); final remotePath = _getRemotePath(file); try { if (useRmrf) { await _client!.run('rm -rf "$remotePath"'); } else if (file.attr.isDirectory) { await _status.client!.rmdir(remotePath); } else { await _status.client!.remove(remotePath); } context.pop(); } catch (e) { context.pop(); context.showRoundDialog( title: Text(_s.error), child: Text(e.toString()), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.ok), ) ], ); return; } _listDir(); }, child: Text(_s.delete, style: textRed), ), ], ); } void _mkdir(BuildContext context) { context.pop(); final textController = TextEditingController(); context.showRoundDialog( title: Text(_s.createFolder), child: Input( autoFocus: true, icon: Icons.folder, controller: textController, label: _s.name, ), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.cancel), ), TextButton( onPressed: () async { if (textController.text == '') { context.showRoundDialog( child: Text(_s.fieldMustNotEmpty), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.ok), ), ], ); return; } final dir = '${_status.path!.path}/${textController.text}'; await _status.client!.mkdir(dir); context.pop(); _listDir(); }, child: Text(_s.ok, style: textRed), ), ], ); } void _newFile(BuildContext context) { context.pop(); final textController = TextEditingController(); context.showRoundDialog( title: Text(_s.createFile), child: Input( autoFocus: true, icon: Icons.insert_drive_file, controller: textController, label: _s.name, ), actions: [ TextButton( onPressed: () async { if (textController.text == '') { context.showRoundDialog( title: Text(_s.attention), child: Text(_s.fieldMustNotEmpty), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.ok), ), ], ); return; } context.pop(); final path = '${_status.path!.path}/${textController.text}'; context.showLoadingDialog(); await _client!.run('touch "$path"'); context.pop(); _listDir(); }, child: Text(_s.ok, style: textRed), ), ], ); } void _rename(BuildContext context, SftpName file) { context.pop(); final textController = TextEditingController(); context.showRoundDialog( title: Text(_s.rename), child: Input( autoFocus: true, icon: Icons.abc, controller: textController, label: _s.name, ), actions: [ TextButton(onPressed: () => context.pop(), child: Text(_s.cancel)), TextButton( onPressed: () async { if (textController.text == '') { context.showRoundDialog( title: Text(_s.attention), child: Text(_s.fieldMustNotEmpty), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.ok), ), ], ); return; } await _status.client!.rename(file.filename, textController.text); context.pop(); _listDir(); }, child: Text(_s.rename, style: textRed), ), ], ); } Future _decompress(BuildContext context, SftpName name) async { context.pop(); final absPath = _getRemotePath(name); final cmd = _getDecompressCmd(absPath); if (cmd == null) { context.showRoundDialog( title: Text(_s.error), child: Text('Unsupport file: ${name.filename}'), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.ok), ), ], ); return; } context.showLoadingDialog(); await _client?.run(cmd); context.pop(); _listDir(); } String _getRemotePath(SftpName name) { final prePath = _status.path!.path; return pathJoin(prePath, name.filename); } Future _getLocalPath(String remotePath) async { return '${await sftpDir}$remotePath'; } /// Only return true if the path is changed Future _listDir({String? path, SSHClient? client}) async { context.showLoadingDialog(); if (client != null) { final sftpc = await client.sftp(); _status.client = sftpc; } try { final listPath = path ?? _status.path?.path ?? '/'; final fs = await _status.client!.listdir(listPath); fs.sort((a, b) => a.filename.compareTo(b.filename)); /// Issue #97 /// In order to compatible with the Synology NAS /// which not has '.' and '..' in listdir if (fs.isNotEmpty && fs.first.filename == '.') { fs.removeAt(0); } /// Issue #96 /// Due to [WillPopScope] added in this page /// There is no need to keep '..' folder in listdir /// So remove it if (fs.isNotEmpty && fs.first.filename == '..') { fs.removeAt(0); } if (mounted) { setState(() { _status.files = fs; }); context.pop(); return true; } return false; } catch (e, trace) { context.pop(); Loggers.app.warning('List dir failed', e, trace); await _backward(); Future.delayed( const Duration(milliseconds: 177), () => context.showRoundDialog( title: Text(_s.error), child: Text(e.toString()), actions: [ TextButton( onPressed: () => context.pop(), child: Text(_s.ok), ) ], ), ); return false; } } Future _backward() async { if (_status.path!.undo()) { await _listDir(); } } @override FutureOr afterFirstLayout(BuildContext context) { final p_ = widget.initPath ?? '/'; _status.path = AbsolutePath(p_); _listDir(path: p_, client: _client); } } String? _getDecompressCmd(String filename) { for (final ext in _extCmdMap.keys) { if (filename.endsWith('.$ext')) { return _extCmdMap[ext]?.replaceAll('FILE', '"$filename"'); } } return null; } bool _canDecompress(String filename) { for (final ext in _extCmdMap.keys) { if (filename.endsWith('.$ext')) { return true; } } return false; } /// Translate from /// https://github.com/ohmyzsh/ohmyzsh/blob/03a0d5bbaedc732436b5c67b166cde954817cc2f/plugins/extract/extract.plugin.zsh const _extCmdMap = { 'tar.gz': 'tar zxvf FILE', 'tgz': 'tar zxvf FILE', 'tar.bz2': 'tar jxvf FILE', 'tbz2': 'tar jxvf FILE', 'tar.xz': 'tar --xz -xvf FILE', 'txz': 'tar --xz -xvf FILE', 'tar.lzma': 'tar --lzma -xvf FILE', 'tlz': 'tar --lzma -xvf FILE', 'tar.zst': 'tar --zstd -xvf FILE', 'tzst': 'tar --zstd -xvf FILE', 'tar': 'tar xvf FILE', 'tar.lz': 'tar xvf FILE', 'tar.lz4': 'lz4 -c -d FILE | tar xvf - ', 'gz': 'gunzip FILE', 'bz2': 'bunzip2 FILE', 'xz': 'unxz FILE', 'lzma': 'unlzma FILE', 'z': 'uncompress FILE', 'zip': 'unzip FILE', 'war': 'unzip FILE', 'jar': 'unzip FILE', 'ear': 'unzip FILE', 'sublime-package': 'unzip FILE', 'ipa': 'unzip FILE', 'ipsw': 'unzip FILE', 'apk': 'unzip FILE', 'xpi': 'unzip FILE', 'aar': 'unzip FILE', 'whl': 'unzip FILE', 'rar': 'unrar x -ad FILE', 'rpm': 'rpm2cpio FILE | cpio --quiet -id', '7z': '7za x FILE', // 'deb': 'mkdir -p "control" "data"' // 'ar vx FILE > /dev/null' // 'cd control; extract ../control.tar.*' // 'cd ../data; extract ../data.tar.*' // 'cd ..; rm *.tar.* debian-binary', 'zst': 'unzstd FILE', 'cab': 'cabextract FILE', 'exe': 'cabextract FILE', 'cpio': 'cpio -idmvF FILE', 'obscpio': 'cpio -idmvF FILE', 'zpaq': 'zpaq x FILE', };