# -*- coding: iso-8859-1 -*-
# This software and supporting documentation are distributed by
# Institut Federatif de Recherche 49
# CEA/NeuroSpin, Batiment 145,
# 91191 Gif-sur-Yvette cedex
# France
#
# This software is governed by the CeCILL license version 2 under
# French law and abiding by the rules of distribution of free software.
# You can use, modify and/or redistribute the software under the
# terms of the CeCILL license version 2 as circulated by CEA, CNRS
# and INRIA at the following URL "http://www.cecill.info".
#
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license version 2 and that you accept its terms.
'''
@author: Yann Cointepas
@organization: U{NeuroSpin<http://www.neurospin.org>} and U{IFR 49<http://www.ifr49.org>}
@license: U{CeCILL version 2<http://www.cecill.info/licences/Licence_CeCILL_V2-en.html>}
'''
from __future__ import print_function
from __future__ import absolute_import
__docformat__ = "epytext en"
from soma.configuration import ConfigurationGroup
from brainvisa.data.temporary import getSystemDefaultTempDir
from soma.signature.api import HasSignature, Signature, VariableSignature, Unicode, \
Choice, OpenedChoice, Boolean, Sequence, FileName
from distutils.spawn import find_executable
import os
#------------------------------------------------------------------------------
def htmlBrowsers():
return [i for i in ('firefox', 'konqueror', 'chrome',
'/opt/google/chrome/chrome', 'explorer', 'opera',
'/Applications/Internet\\ Explorer.app/Contents'
'/MacOS/Internet\\ Explorer',
'/Applications/Safari.app/Contents/MacOS/Safari',
'mozilla', 'netscape') if find_executable(i)]
[docs]def defaultHTMLBrowser():
"""
If a real web browser is found, use it dy default.
If there is no web browser available, the built-in Qt Browser is used but it cannot open websites.
"""
defaultBrowser = ""
browsers = htmlBrowsers()
if browsers:
defaultBrowser = browsers[0]
return defaultBrowser
def textEditors():
return [t for t in ('featherpad', 'mousepad', 'leafpad',
'gedit', 'nedit', 'kedit', 'kwrite',
'xemacs', 'emacs', 'textedit', 'notepad',
'kate') if find_executable(t)]
def defaultTextEditor():
defaultEditor = ''
editors = textEditors()
if editors:
defaultEditor = editors[0]
return defaultEditor
#------------------------------------------------------------------------------
def csvViewers():
return [i for i in ('gnumeric', 'openoffice', 'libreoffice')
if find_executable(i)]
[docs]def defaultCSVViewer():
"""
If a real CSV viewer is found, use it dy default.
If there is no CSV viewer available, the built-in Qt viewer is used.
"""
defaultCSVviewer = ""
browsers = csvViewers()
if browsers:
defaultCSVviewer = browsers[0]
return defaultCSVviewer
#------------------------------------------------------------------------------
def pngViewers():
return [i for i in ('eog', 'shotwell', 'feh', 'geeqie', 'gpicview',
'lximage-qt',
'gwenview', 'mirage') if find_executable(i)]
[docs]def defaultPNGViewer():
"""
If a real PNG viewer is found, use it dy default.
If there is no PNG viewer available, the built-in Qt viewer is used.
"""
defaultPNGviewer = ""
browsers = pngViewers()
if browsers:
defaultPNGviewer = browsers[0]
return defaultPNGviewer
#------------------------------------------------------------------------------
[docs]class BrainVISAConfiguration(ConfigurationGroup):
label = 'BrainVISA'
icon = 'brainvisa_small.png'
[docs] class SupportConfiguration(HasSignature):
signature = Signature(
'userEmail', Unicode, dict(
defaultValue='', doc='Your email address that will appear in the "From:" field of messages send to BrainVISA support team.'),
'supportEmail', Unicode, dict(
defaultValue='support@brainvisa.info', doc='Email address of BrainVISA support team.'),
'smtpServer', Unicode, dict(
defaultValue='', doc='Address of the server that will be used to send emails.'),
)
[docs] class SPMConfiguration(HasSignature):
signature = Signature(
'SPM99_compatibility', Boolean, dict(
defaultValue=False, doc='If selected, Analyse (*.hdr + *.img) images loaded from BrainVISA, Anatomist and Aims will use an heuristic to guess the orientationin in SPM99 compatible way.'),
'radiological_orientation', Boolean, dict(
defaultValue=True, doc='If selected, SPM is supposed to use radiological orientation for images. Otherwise it is supposed to use neurological convention.'),
)
signature = Signature(
'userLevel', Choice(('Basic', 0),
('Advanced', 1),
('Expert', 2)),
dict(
defaultValue=0, doc='User level is used to hide experimental processes (and in some rare cases hide experimental parameters).'),
'language', Choice(
('<system default>', None), ('english', 'en'), ('french', 'fr')),
dict(
defaultValue='en', doc='Language of the graphical interface (it is necessary to restart BrainVISA to take the modification into account).'),
'processesPath', Sequence(FileName(directoryOnly=True)), dict(
defaultValue=[
], doc='List of directories containing BrainVISA processes.'),
'temporaryDirectory', FileName(directoryOnly=True), dict(defaultValue=getSystemDefaultTempDir(),
doc='Directory where temporary files are stored. Name of temporary files produced by BrainVISA starts with <tt>"bv_"</tt>.'),
'textEditor', OpenedChoice(* textEditors()), dict(
defaultValue=defaultTextEditor(
), doc='Location of the program used to edit text files.'),
'htmlBrowser', OpenedChoice(('<built-in>', ''), * htmlBrowsers()), dict(
defaultValue=defaultHTMLBrowser(
), doc='Location of the program used to display HTML files.'),
'csvViewer', OpenedChoice(('<built-in>', ''), * csvViewers()), dict(
defaultValue=defaultCSVViewer(
), doc='Location of the program used to display CSV files.'),
'pngViewer', OpenedChoice(('<built-in>', ''), * pngViewers()), dict(
defaultValue=defaultPNGViewer(
), doc='Location of the program used to display PNG images.'),
'removeTemporary', Boolean, dict(
defaultValue=True, doc='unselect this option if you do not want temporary files and directories to be automatically deleted. This option is used for debugging. If unselected BrainVISA can leave a lot of files in temporary directory.'),
'showParamUserLevel', Boolean, dict(
defaultValue=False, doc='select this option if you want user levels shown along parameter names in the process window.'),
'SPM', SPMConfiguration, dict(defaultValue=SPMConfiguration()),
'support', SupportConfiguration, dict(
defaultValue=SupportConfiguration()),
'gui_style', OpenedChoice(('<system default>', None)), dict(
defaultValue=None, doc='Style of the graphical interface.'),
'databasesWarning', Boolean, dict(
defaultValue=True, doc='Unselect this option to disable the warning message that is shown when you have not created any database.'),
'databaseVersionSync', Choice(
('Ask User', None), ('Automatic', 'auto'), ('Manual', 'man')),
dict(defaultValue=None,
doc='Management of the database synchronization throught BrainVISA versions. Ask User : BrainVISA will ask what to do when a database need to be updated. Automatic : BrainVISA will automatically update your database if you switch from one BrainVISA version to another. Manual : If you modify a database and then switch from one BrainVISA version to another, you will have to update the database if you want BrainVISA take into account the modifications.'),
)
def _check_userLevel_value(self, value):
return int(value)
def _check_temporaryDirectory_value(self, newDirectory):
if not newDirectory or \
(newDirectory and not os.path.exists(newDirectory)):
print('Configuration - temporaryDirectory option : No such file or directory: "' +
newDirectory + '". Returned to default value.')
return self.signature['temporaryDirectory'].defaultValue
return newDirectory
def __init__(self):
super(BrainVISAConfiguration, self).__init__()
self.signature = VariableSignature(self.signature)
