Tools.Directories Namespace Reference

Functions
def	InitDefaultPaths ()
def	resolveFilename (scope, base="", path_prefix=None)
def	fileReadLine (filename, default=None, source=DEFAULT_MODULE_NAME, debug=False)
def	fileWriteLine (filename, line, source=DEFAULT_MODULE_NAME, debug=False)
def	fileReadLines (filename, default=None, source=DEFAULT_MODULE_NAME, debug=False)
def	fileWriteLines (filename, lines, source=DEFAULT_MODULE_NAME, debug=False)
def	fileReadXML (filename, default=None, source=DEFAULT_MODULE_NAME, debug=False)
def	defaultRecordingLocation (candidate=None)
def	bestRecordingLocation (candidates)
def	getRecordingFilename (basename, dirname=None)
def	copyFile (src, dst)
def	copyfile (src, dst)
def	copyTree (src, dst, symlinks=False)
def	copytree (src, dst, symlinks=False)
def	moveFiles (fileList)
def	comparePaths (leftPath, rightPath)
def	crawlDirectory (directory, pattern)
def	createDir (path, makeParents=False)
def	renameDir (oldPath, newPath)
def	removeDir (path)
def	fileAccess (file, mode="r")
def	fileCheck (file, mode="r")
def	fileExists (file, mode="r")
def	fileContains (file, content, mode="r")
def	fileHas (file, content, mode="r")
def	hasHardLinks (path)
def	getSize (path, pattern=".*")
def	shellQuote (string)
def	shellquote (string)
def	lsof ()
def	getExtension (file)
def	mediaFilesInUse (session)
def	isPluginInstalled (pluginName, pluginFile="plugin", pluginType=None)

Variables
	DEFAULT_MODULE_NAME = __name__.split(".")[-1]
int	forceDebug = eGetEnigmaDebugLvl() > 4
	pathExists = exists
int	SCOPE_HOME = 0
int	SCOPE_LANGUAGE = 1
int	SCOPE_KEYMAPS = 2
int	SCOPE_METADIR = 3
int	SCOPE_SKINS = 4
int	SCOPE_GUISKIN = 5
int	SCOPE_LCDSKIN = 6
int	SCOPE_FONTS = 7
int	SCOPE_PLUGINS = 8
int	SCOPE_PLUGIN = 9
int	SCOPE_PLUGIN_ABSOLUTE = 10
int	SCOPE_PLUGIN_RELATIVE = 11
int	SCOPE_SYSETC = 12
int	SCOPE_TRANSPONDERDATA = 13
int	SCOPE_CONFIG = 14
int	SCOPE_PLAYLIST = 15
int	SCOPE_MEDIA = 16
int	SCOPE_HDD = 17
int	SCOPE_TIMESHIFT = 18
int	SCOPE_DEFAULTDIR = 19
int	SCOPE_LIBDIR = 20
int	SCOPE_ACTIVE_LCDSKIN = SCOPE_LCDSKIN
int	SCOPE_ACTIVE_SKIN = SCOPE_GUISKIN
int	SCOPE_CURRENT_LCDSKIN = SCOPE_LCDSKIN
int	SCOPE_CURRENT_PLUGIN = SCOPE_PLUGIN
int	SCOPE_CURRENT_SKIN = SCOPE_GUISKIN
int	SCOPE_SKIN = SCOPE_SKINS
int	SCOPE_SKIN_IMAGE = SCOPE_SKINS
int	SCOPE_USERETC = SCOPE_HOME
int	PATH_CREATE = 0
int	PATH_DONTCREATE = 1
dictionary	defaultPaths
dictionary	scopeConfig = defaultPaths[SCOPE_CONFIG][0]
dictionary	scopeGUISkin = defaultPaths[SCOPE_GUISKIN][0]
dictionary	scopeLCDSkin = defaultPaths[SCOPE_LCDSKIN][0]
dictionary	scopeFonts = defaultPaths[SCOPE_FONTS][0]
dictionary	scopePlugins = defaultPaths[SCOPE_PLUGINS][0]

Function Documentation

bestRecordingLocation()

def Tools.Directories.bestRecordingLocation

(

candidates

)

comparePaths()

def Tools.Directories.comparePaths	(		leftPath,
			rightPath
	)

copyFile()

def Tools.Directories.copyFile	(		src,
			dst
	)

copyfile()

def Tools.Directories.copyfile	(		src,
			dst
	)

copyTree()

def Tools.Directories.copyTree	(		src,
			dst,
			symlinks = False
	)

copytree()

def Tools.Directories.copytree	(		src,
			dst,
			symlinks = False
	)

crawlDirectory()

def Tools.Directories.crawlDirectory	(		directory,
			pattern
	)

createDir()

def Tools.Directories.createDir	(		path,
			makeParents = False
	)

defaultRecordingLocation()

def Tools.Directories.defaultRecordingLocation

(

candidate = None

)

fileAccess()

def Tools.Directories.fileAccess	(		file,
			mode = "r"
	)

fileCheck()

def Tools.Directories.fileCheck	(		file,
			mode = "r"
	)

fileContains()

def Tools.Directories.fileContains	(		file,
			content,
			mode = "r"
	)

fileExists()

def Tools.Directories.fileExists	(		file,
			mode = "r"
	)

fileHas()

def Tools.Directories.fileHas	(		file,
			content,
			mode = "r"
	)

fileReadLine()

def Tools.Directories.fileReadLine	(		filename,
			default = None,
			source = DEFAULT_MODULE_NAME,
			debug = False
	)

fileReadLines()

def Tools.Directories.fileReadLines	(		filename,
			default = None,
			source = DEFAULT_MODULE_NAME,
			debug = False
	)

fileReadXML()

def Tools.Directories.fileReadXML	(		filename,
			default = None,
			source = DEFAULT_MODULE_NAME,
			debug = False
	)

fileWriteLine()

def Tools.Directories.fileWriteLine	(		filename,
			line,
			source = DEFAULT_MODULE_NAME,
			debug = False
	)

fileWriteLines()

def Tools.Directories.fileWriteLines	(		filename,
			lines,
			source = DEFAULT_MODULE_NAME,
			debug = False
	)

getExtension()

def Tools.Directories.getExtension

(

file

)

getRecordingFilename()

def Tools.Directories.getRecordingFilename	(		basename,
			dirname = None
	)

getSize()

def Tools.Directories.getSize	(		path,
			pattern = ".*"
	)

hasHardLinks()

def Tools.Directories.hasHardLinks

(

path

)

InitDefaultPaths()

def Tools.Directories.InitDefaultPaths

(

)

isPluginInstalled()

def Tools.Directories.isPluginInstalled	(		pluginName,
			pluginFile = "plugin",
			pluginType = None
	)

lsof()

def Tools.Directories.lsof

(

)

mediaFilesInUse()

def Tools.Directories.mediaFilesInUse

(

session

)

moveFiles()

def Tools.Directories.moveFiles

(

fileList

)

removeDir()

def Tools.Directories.removeDir

(

path

)

renameDir()

def Tools.Directories.renameDir	(		oldPath,
			newPath
	)

resolveFilename()

def Tools.Directories.resolveFilename	(		scope,
			base = "",
			path_prefix = None
	)

shellQuote()

def Tools.Directories.shellQuote

(

string

)

shellquote()

def Tools.Directories.shellquote

(

string

)

Variable Documentation

DEFAULT_MODULE_NAME

Tools.Directories.DEFAULT_MODULE_NAME = __name__.split(".")[-1]

defaultPaths

dictionary Tools.Directories.defaultPaths

Initial value:

=  {
  SCOPE_HOME: ("", PATH_DONTCREATE),  # User home directory
  SCOPE_LANGUAGE: (eEnv.resolve("${datadir}/enigma2/po/"), PATH_DONTCREATE),
  SCOPE_KEYMAPS: (eEnv.resolve("${datadir}/keymaps/"), PATH_CREATE),
  SCOPE_METADIR: (eEnv.resolve("${datadir}/meta/"), PATH_CREATE),
  SCOPE_SKINS: (eEnv.resolve("${datadir}/enigma2/"), PATH_DONTCREATE),
  SCOPE_GUISKIN: (eEnv.resolve("${datadir}/enigma2/"), PATH_DONTCREATE),
  SCOPE_LCDSKIN: (eEnv.resolve("${datadir}/enigma2/display/"), PATH_DONTCREATE),
  SCOPE_FONTS: (eEnv.resolve("${datadir}/fonts/"), PATH_DONTCREATE),
  SCOPE_PLUGINS: (eEnv.resolve("${libdir}/enigma2/python/Plugins/"), PATH_CREATE),
  SCOPE_PLUGIN: (eEnv.resolve("${libdir}/enigma2/python/Plugins/"), PATH_CREATE),
  SCOPE_PLUGIN_ABSOLUTE: (eEnv.resolve("${libdir}/enigma2/python/Plugins/"), PATH_DONTCREATE),
  SCOPE_PLUGIN_RELATIVE: (eEnv.resolve("${libdir}/enigma2/python/Plugins/"), PATH_DONTCREATE),
  SCOPE_SYSETC: (eEnv.resolve("${sysconfdir}/"), PATH_DONTCREATE),
  SCOPE_TRANSPONDERDATA: (eEnv.resolve("${sysconfdir}/"), PATH_DONTCREATE),
  SCOPE_CONFIG: (eEnv.resolve("${sysconfdir}/enigma2/"), PATH_CREATE),
  SCOPE_PLAYLIST: (eEnv.resolve("${sysconfdir}/enigma2/playlist/"), PATH_CREATE),
  SCOPE_MEDIA: ("/media/", PATH_DONTCREATE),
  SCOPE_HDD: ("/media/hdd/movie/", PATH_DONTCREATE),
  SCOPE_TIMESHIFT: ("/media/hdd/timeshift/", PATH_DONTCREATE),
  SCOPE_DEFAULTDIR: (eEnv.resolve("${datadir}/enigma2/defaults/"), PATH_CREATE),
  SCOPE_LIBDIR: (eEnv.resolve("${libdir}/"), PATH_DONTCREATE)
}

forceDebug

int Tools.Directories.forceDebug = eGetEnigmaDebugLvl() > 4

PATH_CREATE

int Tools.Directories.PATH_CREATE = 0

PATH_DONTCREATE

int Tools.Directories.PATH_DONTCREATE = 1

pathExists

Tools.Directories.pathExists = exists

SCOPE_ACTIVE_LCDSKIN

int Tools.Directories.SCOPE_ACTIVE_LCDSKIN = SCOPE_LCDSKIN

SCOPE_ACTIVE_SKIN

int Tools.Directories.SCOPE_ACTIVE_SKIN = SCOPE_GUISKIN

SCOPE_CONFIG

int Tools.Directories.SCOPE_CONFIG = 14

SCOPE_CURRENT_LCDSKIN

int Tools.Directories.SCOPE_CURRENT_LCDSKIN = SCOPE_LCDSKIN

SCOPE_CURRENT_PLUGIN

int Tools.Directories.SCOPE_CURRENT_PLUGIN = SCOPE_PLUGIN

SCOPE_CURRENT_SKIN

int Tools.Directories.SCOPE_CURRENT_SKIN = SCOPE_GUISKIN

SCOPE_DEFAULTDIR

int Tools.Directories.SCOPE_DEFAULTDIR = 19

SCOPE_FONTS

int Tools.Directories.SCOPE_FONTS = 7

SCOPE_GUISKIN

int Tools.Directories.SCOPE_GUISKIN = 5

SCOPE_HDD

int Tools.Directories.SCOPE_HDD = 17

SCOPE_HOME

int Tools.Directories.SCOPE_HOME = 0

SCOPE_KEYMAPS

int Tools.Directories.SCOPE_KEYMAPS = 2

SCOPE_LANGUAGE

int Tools.Directories.SCOPE_LANGUAGE = 1

SCOPE_LCDSKIN

int Tools.Directories.SCOPE_LCDSKIN = 6

SCOPE_LIBDIR

int Tools.Directories.SCOPE_LIBDIR = 20

SCOPE_MEDIA

int Tools.Directories.SCOPE_MEDIA = 16

SCOPE_METADIR

int Tools.Directories.SCOPE_METADIR = 3

SCOPE_PLAYLIST

int Tools.Directories.SCOPE_PLAYLIST = 15

SCOPE_PLUGIN

int Tools.Directories.SCOPE_PLUGIN = 9

SCOPE_PLUGIN_ABSOLUTE

int Tools.Directories.SCOPE_PLUGIN_ABSOLUTE = 10

SCOPE_PLUGIN_RELATIVE

int Tools.Directories.SCOPE_PLUGIN_RELATIVE = 11

SCOPE_PLUGINS

int Tools.Directories.SCOPE_PLUGINS = 8

SCOPE_SKIN

int Tools.Directories.SCOPE_SKIN = SCOPE_SKINS

SCOPE_SKIN_IMAGE

int Tools.Directories.SCOPE_SKIN_IMAGE = SCOPE_SKINS

SCOPE_SKINS

int Tools.Directories.SCOPE_SKINS = 4

SCOPE_SYSETC

int Tools.Directories.SCOPE_SYSETC = 12

SCOPE_TIMESHIFT

int Tools.Directories.SCOPE_TIMESHIFT = 18

SCOPE_TRANSPONDERDATA

int Tools.Directories.SCOPE_TRANSPONDERDATA = 13

SCOPE_USERETC

int Tools.Directories.SCOPE_USERETC = SCOPE_HOME

scopeConfig

dictionary Tools.Directories.scopeConfig = defaultPaths[SCOPE_CONFIG][0]

scopeFonts

dictionary Tools.Directories.scopeFonts = defaultPaths[SCOPE_FONTS][0]

scopeGUISkin

dictionary Tools.Directories.scopeGUISkin = defaultPaths[SCOPE_GUISKIN][0]

scopeLCDSkin

dictionary Tools.Directories.scopeLCDSkin = defaultPaths[SCOPE_LCDSKIN][0]

scopePlugins

dictionary Tools.Directories.scopePlugins = defaultPaths[SCOPE_PLUGINS][0]