Difference between revisions of "Projects/KioFuse"

Revision as of 02:34, 2 January 2008

KioFuse allows you to mount remote directories into the root hierarchy of your local file system, thereby exposing KDE's advanced access capabilities (SSH, SAMBA/Windows, FTP, TAR/GZip/BZip2, WebDav, etc) to POSIX-compliant applications such as Firefox, OpenOffice, GNOME apps, shell utilities and more. Another important advantage of KioFuse is that it allows you to arrange the hierarchy of all your remote, archived and compressed files in whichever way makes sense to you.

KioFuse works by acting as a bridge between KDE's KIO filesystem design and FUSE.

Installation

Install kdelibs (version 4.0 or higher) provided by your Operating System or compile it according to these intructions.
Type the following commands into a terminal:

svn checkout svn://anonsvn.kde.org/home/kde/trunk/playground/libs/kiofuse cd kiofuse cmake . make

Running KioFuse

Mount with:

kiofuse --mountpoint <mountpoint> --URL <URL>

Unmount with:

fusermount -u <mountpoint>

Real-world example:


 Create the mount point

mkdir ~/fuse-source

 Download the compressed archive of the FUSE source code

wget http://superb-east.dl.sourceforge.net/sourceforge/fuse/fuse-2.7.2.tar.gz -P ~

 Mount the archive in ~/fuse-source

./kiofuse --mountpoint ~/fuse-source --URL tar:~/fuse-2.7.2.tar.gz &

 Browse the source code in your favorite filemanager without ever needing to unpack the archive!

dolphin ~/fuse-source & nautilus ~/fuse-source & thunar ~/fuse-source &

Screenshots

Features and TODO

Some KIO slaves such as tar: don't support seeking and therefore won't be able to read or write to files. Fixing these slaves is on the TODO list.
KIO needs to be modified so that it is aware of KioFuse mounts and so that it uses its native functions (as opposed to POSIX) to access those resources.

POSIX Capabilities

See the FUSE API for the list of all file I/O commands.

Name	Description	Filename
GetAttr	Permissions, Owner, Group	Done
ReadLink	Determine destination of link	Done
MkNod	Create file	Done
MkDir	Create a directory	Not Started
UnLink	Remove a symlink	Not Started
RmDir	Remove a directory	Not Started
SymLink	Create a symlink	Not Started
Rename	Rename a file or directory	Not Started
Link	Create a hard link	Not Started
Chmod	Change permissions of a file or directory	Work In Progress
Chown	Change owner of a file or directory	Work In Progress
Truncate	Change the size of a file	Not Started
Open	Open a file for reading, writing, and/or truncating	Done
Read	Read the contents of a file	Done
Write	Write data to a file	Done
Truncate	Change the size of a file	Not Started
StatFS	Get Filesystem Statistics	Not Started
Flush	Flush cached data	Not Started
FSync	Synchronize file contents	Not Started
SetXAttr	Set external attributes	Not Started
GetXAttr	Get external attributes	Not Started
ListXAttr	List external attributes	Not Started
RemoveXAttr	Remove external attributes	Not Started
OpenDir	Open a directory	Not Started
ReadDir	List files and subdirectories	Done
ReleaseDir	Release directory	Not Started
FSyncDir	Synchronize directory contents	Not Started
Init	Initialize filesystem	Not Started
Destroy	Clean up filesystem	Not Started
Access	Check file access permissions	Work In Progress
Create	Create and open a file	Not Started
FTruncate	Change the size of an open file	Not Started
FGetAttr	Get attributes of an open file	Not Started
Lock	Lock a resource	Not Started
UTimeNS	Change the access and mod times in nanoseconds	Not Started

Source Code

The source code to KioFuse can be browsed at: http://websvn.kde.org/trunk/playground/libs/kiofuse/

@@ Line 43: / Line 43: @@
 * KIO needs to be modified so that it is aware of KioFuse mounts and so that it uses its native functions (as opposed to POSIX) to access those resources.
 === POSIX Capabilities ===
-See the FUSE API for a [http://fuse.sourceforge.net/doxygen/structfuse__operations.html constantly updated list].
+See the FUSE API for the list of all [http://fuse.sourceforge.net/doxygen/structfuse__operations.html file I/O commands].
 {| border="1"
 ! Name !! Description !! Filename
@@ Line 51: / Line 51: @@
 | ReadLink || Determine destination of link || style="background-color: lightgreen;" | Done
 |-
-| MkNod || Create file || style="background-color:#ffc642;" | Work In Progress
+| MkNod || Create file || style="background-color: lightgreen;" | Done
 |-
 | MkDir || Create a directory || style="background-color:#ff4242;" | Not Started
@@ Line 65: / Line 65: @@
 | Link || Create a hard link || style="background-color:#ff4242;" | Not Started
 |-
-| Chmod || Change permissions of a file or directory || style="background-color:#ff4242;" | Not Started
+| Chmod || Change permissions of a file or directory || style="background-color:#ffc642;" | Work In Progress
 |-
-| Chown || Change owner of a file or directory || style="background-color:#ff4242;" | Not Started
+| Chown || Change owner of a file or directory || style="background-color:#ffc642;" | Work In Progress
 |-
 | Truncate || Change the size of a file || style="background-color:#ff4242;" | Not Started
@@ Line 75: / Line 75: @@
 | Read || Read the contents of a file || style="background-color: lightgreen;" | Done
 |-
-| Write || Write data to a file || style="background-color:#ffc642;" | Work In Progress
+| Write || Write data to a file || style="background-color: lightgreen;" | Done
 |-
 | Truncate || Change the size of a file || style="background-color:#ff4242;" | Not Started