FileExpo

https://github.com/zsdev07/fileexpo
Admin
FileExpo is a feature-rich Flutter-based Android file explorer with built-in text editor, image...
Tokens:5,628
Snippets:41
Trust Score:4.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### App Bootstrap with MultiProvider Setup

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Sets up the application by providing various services using MultiProvider, making them available to descendant widgets. Consuming services can be done using context.watch() for reactive updates or context.read() for one-shot access.

```dart
// main.dart
void main() {
  runApp(
    MultiProvider(
      providers: [
        ChangeNotifierProvider(create: (_) => FileService()),
        ChangeNotifierProvider(create: (_) => TabService()),
        ChangeNotifierProvider(create: (_) => StorageService()),
        ChangeNotifierProvider(create: (_) => AppService()),
        ChangeNotifierProvider(create: (_) => RootService()),
        ChangeNotifierProvider(create: (_) => CloudService()),
        ChangeNotifierProvider(create: (_) => NetworkService()),
        ChangeNotifierProvider(create: (_) => WebServerService()),
        ChangeNotifierProvider(create: (_) => SecurityService()),
      ],
      child: const FileExpoApp(),
    ),
  );
}

// Consuming a service in any widget:
class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // watch: rebuilds on change
    final fileService = context.watch<FileService>();
    // read: one-shot, no rebuild
    final security = context.read<SecurityService>();

    return Text(fileService.currentDirectory.path);
  }
}
```

--------------------------------

### Start and Stop Local HTTP Server for Wi-Fi Sharing

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Starts a local HTTP server on port 8080 bound to the device's Wi-Fi IP address. Browsers on the same network can access files. Stop the server when it's no longer needed.

```dart
final webServer = context.read<WebServerService>();

// Start the server
await webServer.startServer();
if (webServer.isRunning) {
  print('Browse files at: ${webServer.serverUrl}');
  // Browse files at: http://192.168.1.42:8080
  // GET http://192.168.1.42:8080/Documents/report.pdf  → downloads the file
  // GET http://192.168.1.42:8080/Photos/               → HTML directory listing
}

// Stop the server when leaving the screen
await webServer.stopServer();
print(webServer.isRunning); // false
```

--------------------------------

### Load, Backup, and Uninstall Android Apps

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Uses the `device_apps` package to manage Android applications. Loads all installed apps including system apps and supports APK backup. Triggers the system uninstall dialog for a specified package.

```dart
final appService = context.read<AppService>();

// Load all installed apps (with icons, system apps included)
await appService.loadApps();

for (final app in appService.apps) {
  print('${app.appName} — ${app.packageName}');
}
// Calculator — com.android.calculator2
// Chrome — com.android.chrome
// ...

// Backup an app's APK to /storage/emulated/0/FileExpo/Backups/
final chrome = appService.apps.firstWhere(
  (a) => a.packageName == 'com.android.chrome',
);
await appService.backupApp(chrome);
// Saves: /storage/emulated/0/FileExpo/Backups/Chrome_120.0.6099.230.apk

// Trigger system uninstall dialog for a package
appService.uninstallApp('com.example.oldapp');
```

--------------------------------

### Integrate with Google Drive using CloudService

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Use CloudService to sign in to Google, list files in Google Drive, and sign out. It returns files as StorageNode objects.

```dart
final cloud = context.read<CloudService>();

// Sign in (opens Google account picker)
await cloud.signIn();
if (!cloud.isSignedIn) return;

print('Signed in as: ${cloud.currentUser!.email}');

// List files in the Drive root ('root' is a valid folder ID)
final nodes = await cloud.listDriveFiles('root');
for (final node in nodes) {
  final type = node.isDirectory ? 'folder' : node.extension;
  final kb = (node.size / 1024).toStringAsFixed(1);
  print('[${type}] ${node.name} — ${kb} KB — modified ${node.modified}');
}
// [folder] My Documents — 0.0 KB — modified 2024-03-15 ...
// [pdf]    Invoice_2024.pdf — 142.3 KB — modified 2024-04-01 ...

// Sign out
await cloud.signOut();
```

--------------------------------

### Connect and List Files via FTP

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Manages an FTP client connection. Ensure the NetworkService is initialized and connected before listing files. Disconnect when finished to release resources.

```dart
final network = context.read<NetworkService>();

// Connect to an FTP server
final ok = await network.connectFTP(
  '192.168.1.100',
  'ftpuser',
  's3cr3t',
  port: 21, // default
);
if (!ok) {
  print('FTP connection failed');
  return;
}

// List files in a remote directory
final files = await network.listFTPFiles('/public/uploads');
for (final node in files) {
  final label = node.isDirectory ? '[DIR]' : '[${node.extension.toUpperCase()}]';
  print('$label ${node.name} — ${node.size} bytes');
}
// [DIR] archives
// [PDF] spec_sheet.pdf — 204800 bytes
// [JPG] product.jpg — 81920 bytes

// Disconnect when done
await network.disconnectFTP();
print(network.isConnected); // false
```

--------------------------------

### Create and Inspect StorageNode

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Represents a file or folder from any source (local, Google Drive, FTP). Useful for constructing nodes manually in tests or custom adapters. Inspect properties like extension, directory status, size, and source.

```dart
// Construct a node manually (e.g., in tests or custom adapters)
final node = StorageNode(
  id: '/storage/emulated/0/Photos/beach.jpg',
  name: 'beach.jpg',
  isDirectory: false,
  size: 2048000,             // bytes
  modified: DateTime(2024, 6, 15),
  source: StorageSource.local,
  mimeType: 'image/jpeg',
);

print(node.extension);       // jpg
print(node.isDirectory);     // false
print('${node.size ~/ 1024} KB'); // 2000 KB

// Check source in UI rendering
switch (node.source) {
  case StorageSource.googleDrive:
    print('Cloud icon');
  case StorageSource.ftp:
    print('Network icon');
  case StorageSource.local:
    print('Local icon');
}
```

--------------------------------

### Analyze and Clean Storage with StorageService

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Employ StorageService to scan storage, categorize files, identify large or junk files, and clean up junk. The analysis may take time on large storage.

```dart
final storage = context.read<StorageService>();

// Trigger a full scan (may take seconds on large storage)
await storage.analyzeStorage();

// Read category breakdown (values in bytes)
storage.storageStats.forEach((category, bytes) {
  final mb = (bytes / (1024 * 1024)).toStringAsFixed(1);
  print('$category: ${mb} MB');
});
// Images: 3412.7 MB
// Videos: 12800.0 MB
// Audio: 540.3 MB
// Documents: 220.8 MB
// Archives: 90.1 MB
// Other: 1024.0 MB

print('Total: ${(storage.totalSize / (1024 * 1024 * 1024)).toStringAsFixed(2)} GB');
// Total: 17.64 GB

// Inspect large files (>100 MB), sorted descending by size
for (final f in storage.largeFiles) {
  print('${f.path}: ${f.lengthSync() ~/ (1024 * 1024)} MB');
}

// Delete all detected junk files in one call
await storage.cleanJunk();
print('Junk files remaining: ${storage.junkFiles.length}'); // 0
```

--------------------------------

### FileService - Core File System Operations

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Provides methods for navigating, creating, renaming, deleting, sharing, and managing selections within the local file system. It also handles copy/paste operations and toggling favorite paths.

```APIDOC
## FileService - Core File System Operations

### Description
`FileService` is the central service for navigating, listing, and mutating the local file system. It manages the active directory, a selection set for batch operations, and a copy/move clipboard. All mutating operations call `refresh()` afterwards to keep the UI in sync.

### Methods

- **navigateTo**(Directory directory)
  Navigates to a specified subdirectory.

- **navigateBack**()
  Navigates up one level in the directory hierarchy.

- **createDirectory**(String name)
  Creates a new folder in the current directory.

- **renameEntity**(FileSystemEntity entity, String newName)
  Renames a file or directory.

- **deleteEntities**(List<String> paths)
  Deletes multiple paths (files or directories, recursive).

- **shareEntities**(List<String> paths)
  Shares files via Android's native share sheet.

- **toggleSelection**(String path)
  Toggles a path in/out of the selection set.

- **setClipboard**(List<String> paths, {bool isCopy})
  Sets the copy/move clipboard with the specified paths.

- **paste**()
  Pastes the contents of the clipboard into the current directory (copy or move).

- **toggleFavorite**(String path)
  Toggles the favorite status of a path.

### Properties

- **isSelectionMode** (bool)
  Indicates if selection mode is active.

- **selectedPaths** (List<String>)
  The list of currently selected paths.

- **favorites** (List<String>)
  The list of favorite paths.

### Example Usage
```dart
// In a widget, obtain the service from Provider:
final fileService = context.read<FileService>();

// Navigate to a subdirectory
fileService.navigateTo(Directory('/storage/emulated/0/Documents'));

// Navigate up one level
fileService.navigateBack();

// Create a new folder in the current directory
await fileService.createDirectory('MyNewFolder');

// Rename a file or directory
final entity = File('/storage/emulated/0/old_name.txt');
await fileService.renameEntity(entity, 'new_name.txt');

// Delete multiple paths (files or directories, recursive)
await fileService.deleteEntities([
  '/storage/emulated/0/temp.log',
  '/storage/emulated/0/OldFolder',
]);

// Share files via Android's native share sheet
fileService.shareEntities(['/storage/emulated/0/photo.jpg']);

// Toggle a path in/out of the selection set (long-press pattern)
fileService.toggleSelection('/storage/emulated/0/report.pdf');
print(fileService.isSelectionMode); // true after first selection

// Copy selected files to clipboard, then paste into current directory
fileService.setClipboard(fileService.selectedPaths.toList(), isCopy: true);
fileService.navigateTo(Directory('/storage/emulated/0/Backup'));
await fileService.paste(); // copies files here

// Move (cut) instead of copy
fileService.setClipboard(['/storage/emulated/0/video.mp4'], isCopy: false);
await fileService.paste(); // moves file, clears clipboard

// Toggle favorites (persisted via SharedPreferences)
fileService.toggleFavorite('/storage/emulated/0/Projects');
print(fileService.favorites); // ['/storage/emulated/0/Projects']
```
```

--------------------------------

### FileService - Core File System Operations in Flutter

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Obtain the `FileService` from Provider to perform file system operations. Use `navigateTo` for directory changes, `createDirectory` for new folders, and `renameEntity` for renaming. Batch operations like `deleteEntities` and `shareEntities` are supported. `toggleSelection` manages item selection for batch actions, and `setClipboard`/`paste` handle copy/move operations. `toggleFavorite` persists user-defined favorites.

```dart
final fileService = context.read<FileService>();

fileService.navigateTo(Directory('/storage/emulated/0/Documents'));

fileService.navigateBack();

await fileService.createDirectory('MyNewFolder');

final entity = File('/storage/emulated/0/old_name.txt');
await fileService.renameEntity(entity, 'new_name.txt');

await fileService.deleteEntities([
  '/storage/emulated/0/temp.log',
  '/storage/emulated/0/OldFolder',
]);

fileService.shareEntities(['/storage/emulated/0/photo.jpg']);

fileService.toggleSelection('/storage/emulated/0/report.pdf');
print(fileService.isSelectionMode); 

fileService.setClipboard(fileService.selectedPaths.toList(), isCopy: true);
fileService.navigateTo(Directory('/storage/emulated/0/Backup'));
await fileService.paste(); 

fileService.setClipboard(['/storage/emulated/0/video.mp4'], isCopy: false);
await fileService.paste(); 

fileService.toggleFavorite('/storage/emulated/0/Projects');
print(fileService.favorites); 

```

--------------------------------

### Access Root Shell and List Protected Directories

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Optionally enables root-level file operations by running commands through `su`. It checks for actual root access before exposing privileged directory listings. Remember to disable root mode when done.

```dart
final rootService = context.read<RootService>();

// Enable root mode — also triggers a root check
rootService.toggleRoot(true);
await Future.delayed(const Duration(milliseconds: 500));

if (!rootService.hasRootAccess) {
  print('Device is not rooted or su not available');
  return;
}

// List contents of a system-protected path
final entries = await rootService.listDirectory('/data/data');
for (final entry in entries) {
  print(entry); // com.android.settings, com.google.android.gms, ...
}

// Disable root mode
rootService.toggleRoot(false);
```

--------------------------------

### FileService - Archive (ZIP) Support in Flutter

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Use `compressToZip` to create a `.zip` archive from a list of paths in the current directory. Use `extractZip` to unpack a `.zip` file into a subfolder named after the archive.

```dart
final fileService = context.read<FileService>();

await fileService.compressToZip(
  ['/storage/emulated/0/Photos', '/storage/emulated/0/notes.txt'],
  'my_backup',
);

final zipFile = File('/storage/emulated/0/Downloads/project.zip');
await fileService.extractZip(zipFile);

```

--------------------------------

### Secure Files with SecurityService

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Utilize SecurityService for biometric authentication, moving files to a hidden vault, and AES-256 file encryption/decryption. Remember to log out to lock the vault session.

```dart
final security = context.read<SecurityService>();

// Prompt biometric/device-credential authentication
final granted = await security.authenticate();
if (!granted) {
  ScaffoldMessenger.of(context).showSnackBar(
    const SnackBar(content: Text('Authentication failed')),
  );
  return;
}

// Move a file into the hidden vault
final sensitiveFile = File('/storage/emulated/0/passport_scan.jpg');
await security.moveToVault(sensitiveFile);

// Move a file back out of the vault
final vaultEntity = File('${security.vaultPath}/passport_scan.jpg');
await security.removeFromVault(vaultEntity, '/storage/emulated/0/Documents');

// Encrypt a file with AES-256 (produces passport_scan.jpg.enc, deletes original)
await security.encryptFile(
  File('/storage/emulated/0/contract.pdf'),
  'my_strong_password',
);

// Decrypt back (produces contract.pdf, deletes .enc file)
await security.decryptFile(
  File('/storage/emulated/0/contract.pdf.enc'),
  'my_strong_password',
);

// Lock the vault session
security.logout();
print(security.isAuthenticated); // false
```

--------------------------------

### Manage Tabs with TabService

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Use TabService to add, switch, update, and remove tabs for multi-pane navigation. Ensure at least one tab remains open.

```dart
final tabService = context.read<TabService>();

// Add a new tab pointing at Downloads
tabService.addTab(Directory('/storage/emulated/0/Download'), 'Downloads');

// Switch the primary pane to tab index 1
tabService.setActiveTab(1);

// Set the secondary (right-hand) pane to tab index 0 for dual-pane comparison
tabService.setSecondaryTab(0);

// Update where a tab is currently pointing (called internally by ExplorerPane)
tabService.updateTabPath(1, Directory('/storage/emulated/0/Music'));

// Close a tab (minimum 1 tab is always kept)
tabService.removeTab(1);

print(tabService.tabs.map((t) => t.name).toList());
// ['Internal Storage', 'Downloads']
```

--------------------------------

### FileService — Archive (ZIP) Support

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Provides functionality to compress files and directories into ZIP archives and extract existing ZIP archives.

```APIDOC
## FileService — Archive (ZIP) Support

### Description
`compressToZip` creates a `.zip` file in the current directory from a list of paths (files or whole directories). `extractZip` unpacks a `.zip` into a subfolder named after the archive.

### Methods

- **compressToZip**(List<String> paths, String archiveName)
  Compresses the specified paths into a ZIP archive named `archiveName` in the current directory.

- **extractZip**(File zipFile)
  Extracts the contents of the given ZIP file into a subfolder named after the archive in the same directory.

### Example Usage
```dart
final fileService = context.read<FileService>();

// Compress selected files into an archive
await fileService.compressToZip(
  ['/storage/emulated/0/Photos', '/storage/emulated/0/notes.txt'],
  'my_backup', // produces my_backup.zip in current directory
);

// Extract a ZIP file
final zipFile = File('/storage/emulated/0/Downloads/project.zip');
await fileService.extractZip(zipFile);
// Extracts to /storage/emulated/0/Downloads/project/
```
```

--------------------------------

### FileService.searchFiles - Advanced File Search in Flutter

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Filter the current directory listing in-memory using `searchFiles`. Supports filtering by name (`query`), extension, minimum size (`minSize`), maximum size (`maxSize`), and modification date (`modifiedAfter`). Returns a `List<FileSystemEntity>`.

```dart
final fileService = context.read<FileService>();

final results = fileService.searchFiles(query: 'invoice');

final jpgs = fileService.searchFiles(query: '', extension: '.jpg');

final largeRecent = fileService.searchFiles(
  query: '',
  minSize: 50 * 1024 * 1024,
  modifiedAfter: DateTime(2024, 1, 1),
);

final pdfs = fileService.searchFiles(
  query: 'report',
  extension: '.pdf',
  minSize: 1024,
  maxSize: 10 * 1024 * 1024,
);

for (final entity in pdfs) {
  print('${entity.path} — ${(entity as File).lengthSync()} bytes');
}

```

--------------------------------

### FileService.searchFiles — Advanced File Search

Source: https://context7.com/zsdev07/fileexpo/llms.txt

Filters the currently loaded directory listing in-memory based on various criteria including name, extension, size, and modification date.

```APIDOC
## FileService.searchFiles — Advanced File Search

### Description
`searchFiles` filters the currently loaded directory listing in-memory. It supports name queries, extension filters, file size bounds (bytes), and a modification date cutoff. Returns a filtered `List<FileSystemEntity>`.

### Parameters

- **query** (String) - Optional - The name query string to filter by.
- **extension** (String) - Optional - The file extension to filter by (e.g., '.pdf').
- **minSize** (int) - Optional - Minimum file size in bytes.
- **maxSize** (int) - Optional - Maximum file size in bytes.
- **modifiedAfter** (DateTime) - Optional - Filters for files modified after this date.

### Returns
`List<FileSystemEntity>` - A list of file system entities matching the search criteria.

### Example Usage
```dart
final fileService = context.read<FileService>();

// Search by name only
final results = fileService.searchFiles(query: 'invoice');

// Search by extension
final jpgs = fileService.searchFiles(query: '', extension: '.jpg');

// Find files larger than 50 MB modified after Jan 1 2024
final largeRecent = fileService.searchFiles(
  query: '',
  minSize: 50 * 1024 * 1024,
  modifiedAfter: DateTime(2024, 1, 1),
);

// Combined: PDF files between 1 KB and 10 MB
final pdfs = fileService.searchFiles(
  query: 'report',
  extension: '.pdf',
  minSize: 1024,
  maxSize: 10 * 1024 * 1024,
);

for (final entity in pdfs) {
  print('${entity.path} — ${(entity as File).lengthSync()} bytes');
}
// Output example:
// /storage/emulated/0/Documents/report_2024.pdf — 2048000 bytes
```
```
Tokens:
Raw