couchpotato.core.softchroot module

class couchpotato.core.softchroot.SoftChroot

Soft Chroot module

Provides chroot feature for interation with Web-UI. Since it is not real chroot, so the name is SOFT CHROOT. The module prevents access to entire file-system, allowing access only to subdirs of SOFT-CHROOT directory.

abs2chroot(path, force=False)

Converts absolute path to chrooted path

chroot2abs(path)

Converts chrooted path to absolute path

get_chroot()

Returns root in chrooted environment

Raises:

RuntimeError: when SoftChroot is not initialized OR enabled

initialize(chdir)

initialize module, by setting soft-chroot-directory

Sets soft-chroot directory and ‘enabled’-flag

Args:

self (SoftChroot) : self chdir (string) : absolute path to soft-chroot

Raises:

SoftChrootInitError: when chdir doesn’t exist

is_root_abs(abspath)

Checks whether absolute path @abspath is the root in the soft-chrooted environment

is_subdir(abspath)

Checks whether @abspath is subdir (on any level) of soft-chroot

exception couchpotato.core.softchroot.SoftChrootInitError

Bases: exceptions.IOError

Error during soft-chroot initialization