/usr/lib/python2.7/dist-packages/turninng/configparser.py is in turnin-ng 1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 | # Turnin-NG, an assignment submitter and manager. --- config parser
# Copyright (C) 2009-2011 Ryan Kavanagh <ryanakca@kubuntu.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import errno
import os.path
import uuid
from configobj import ConfigObj
# The Project prefix represents classes that were used by 'project', now
# 'turnincfg'.
# The Turnin prefix represents classes that are used by 'turnin'.
class ProjectGlobal(object):
""" This class class represents the global configurations for the
turnincfg command.
"""
def __init__(self, config_file):
"""
Initialize. We'll create the configuration file if it doesn't
already exist. We'll also add the [Global] section if it isn't
already present.
@type config_file: string
@param config_file: path to the project configuration file
@rtype: None
"""
self.config = ConfigObj()
self.config.filename = config_file
self.config.indent_type = ' '
self.config.unrepr = True
self.config.reload()
self.config_defaults = {'default': ''}
if not self.config.has_key('Global'):
self.config['Global'] = self.config_defaults
self.config.write()
else:
self.config_ref = self.config['Global']
self.upgrade_config()
def upgrade_config(self):
""" Update the configuration file from a previous release. """
for key, default in self.config_defaults.items():
if not self.config_ref.has_key(key):
self.config_ref[key] = default
try:
self.config.write()
except IOError, err:
if err.errno == errno.EACCES:
# We don't have write permissions, we're probably running as a
# student, ignore.
pass
def set_default(self, course):
"""
Set the course 'course' as the default course for this professor.
@type course: string
@param course: Name of the course we want to set as default
@rtype: None
@raise ValueError: We try to set a non-existent course as default.
"""
if self.config.has_key(course):
self.config['Global']['default'] = course
self.config.write()
else:
raise ValueError("Please add the course %s first." % course)
class ProjectAdminCourse(ProjectGlobal):
""" This class represents a course object for turnincfg in the global
configuration file.
"""
def __init__(self, config_file, course):
"""
Initialize the course. If it doesn't already exist, we'll create it.
self.course will be a shortcut to access the course configurations.
@type config_file: string
@param config_file: path to the project configuration file
@type course: string
@param course: name of the course
@rtype: None
"""
super(ProjectAdminCourse, self).__init__(config_file)
self.config_defaults = {'projlist': '', 'user': '', 'directory': '',
'group': '', 'group_managed': False}
if not self.config.has_key(course):
self.config[course] = self.config_defaults
self.config.write()
else:
self.config_ref = self.config[course]
self.upgrade_config()
self.course = self.config[course]
""" @ivar: A shortcut to access the course configurations. """
def write(self, user='', directory='', group='', group_managed=False):
""" Modifies the config file.
@type user: string
@param user: username that owns the course directory.
@type directory: string
@param directory: path to the course submission directory.
@type group: string
@param group: group that owns the course directory.
@type group_managed: Bool
@param group_managed: Course managed by a group instead of a user?
@rtype: None
"""
if user:
self.course['user'] = user
if directory:
self.course['directory'] = directory
if group:
self.course['group'] = group
if group_managed != self.course['group_managed']:
self.course['group_managed'] = group_managed
self.course['projlist'] = os.path.join(self.course['directory'],
'turnin-ng.cf')
self.config.write()
projlist = ProjectCourse(self.course['projlist'], self.course.name)
projlist.write(user = self.course['user'],
directory = self.course['directory'],
group = self.course['group'],
group_managed = self.course['group_managed'])
class ProjectCourse(ProjectGlobal):
""" This class represents a course object for in the course configuration
file (projlist) for turnincfg.
"""
def __init__(self, config_file, course):
"""
Initialize the course. If it doesn't already exist, we'll create it.
self.course will be a shortcut to access the course configurations.
@type config_file: string
@param config_file: path to the project configuration file
@type course: string
@param course: name of the course
@rtype: None
"""
super(ProjectCourse, self).__init__(config_file)
self.config_defaults = {'default': '', 'user': '', 'directory': '',
'group': '', 'group_managed': False}
if not self.config.has_key(course):
self.config[course] = self.config_defaults
self.config.write()
else:
self.config_ref = self.config[course]
self.upgrade_config()
self.course = self.config[course]
""" @ivar: A shortcut to access the course configurations. """
def set_default(self, project):
"""
Set the project 'project' as the default project for this course.
@type project: string
@param project: Name of the project we want to set as default
@rtype: None
@raise ValueError: We try to set a non-existent project as default.
"""
if self.course.has_key(project):
self.course['default'] = project
self.config.write()
else:
raise ValueError("Please add the project %s first." % project)
def write(self, user='', directory='', group='', group_managed=False):
""" Modifies the config file.
@type user: string
@param user: username that owns the course directory.
@type directory: string
@param directory: path to the course submission directory.
@type group: string
@param group: group that owns the course directory.
@rtype: None
"""
if user:
self.course['user'] = user
if directory:
self.course['directory'] = directory
if group:
self.course['group'] = group
if group_managed != self.course['group_managed']:
self.course['group_managed'] = group_managed
self.config.write()
class ProjectProject(ProjectCourse):
""" This class represents a project object for turnincfg. """
def __init__(self, config_file, course, project):
"""
Initialize the project. If it doesn't already exist, we'll create it.
self.project will be a shortcut to access the project configurations.
@type config_file: string
@param config_file: path to the project configuration file
@type course: string
@param course: name of the course
@type project: string
@param project: name of the project.
@rtype: None
"""
super(ProjectProject, self).__init__(config_file, course)
self.config_defaults = {'enabled': False, 'description': '',
'uuid': str(uuid.uuid4()), 'managing_accounts': []}
if not self.course.has_key(project):
self.config[course][project] = self.config_defaults
self.config.write()
else:
self.config_ref = self.config[course][project]
self.upgrade_config()
self.project = self.course[project]
""" @ivar: shortcut to the project configurations """
self.project['directory'] = os.path.join(self.course['directory'],
project)
self.name = project
def write(self, enabled, description='', directory='', tarball='',
default=False):
"""
Modifies the config file.
@type enabled: Bool
@param enabled: Is this course enabled? True/False
@type description: string
@param description: Optional description for this project.
@type directory: string
@param directory: project directory
@type tarball: string
@param tarball: Path to the compressed project's tarball.
@rtype: None
"""
self.project['enabled'] = enabled
if description:
self.project['description'] = description
if default:
super(ProjectProject, self).set_default(self.name)
if directory:
self.project['directory'] = directory
if tarball:
self.project['tarball'] = tarball
if not enabled:
if self.course['default'] == self.name:
self.course['default'] = ''
self.config.write()
def add_manager(self, manager):
"""
Adds a UNIX username that has managed the projects.
@type manager: string
@param manager: username that has managed accounts
@rtype: None
"""
if manager not in self.project['managing_accounts']:
self.project['managing_accounts'].append(manager)
self.config.write()
self.config.reload()
class TurninGlobal(object):
"""
This class class represents the global configurations for the turnin
command.
"""
def __init__(self, config_file):
"""
Initialize the global configurations.
@type config_file: string
@param config_file: path to the project configuration file
@rtype: None
@raise ValueError: The user is trying to use a poorly formatted
configuration file.
"""
self.config = ConfigObj()
self.config.filename = config_file
self.config.indent_type = ' '
self.config.unrepr = True
self.config.reload()
if not self.config.has_key('Global'):
raise ValueError("Invalid config file")
class TurninCourse(TurninGlobal):
""" This class represents a course object for turnin. """
def __init__(self, config_file, course):
"""
Initialize the turnin course object. self.course is an alias to access
the course configurations.
@type config_file: string
@param config_file: path to the project configuration file
@type course: string
@param course: name of the course
@rtype: None
@raise ValueError: The course isn't defined in the config file.
"""
super(TurninCourse, self).__init__(config_file)
if not self.config.has_key(course):
raise ValueError("Course %s does not exists!" % course)
self.course = self.config[course]
""" @ivar: shortcut to the course configurations. """
class TurninProject(TurninCourse):
""" This class represents a turnin course's project object. """
def __init__(self, config_file, course, project):
"""
Initialize the project's configurations for turnin.
self.project will be a shortcut to access the project configurations.
@type config_file: string
@param config_file: path to the project configuration file
@type course: string
@param course: name of the course
@type project: string
@param project: name of the project.
@rtype: None
@raise ValueError: The project isn't defined in the config file.
"""
super(TurninProject, self).__init__(config_file, course)
if not self.course.has_key(project):
raise ValueError("Project %s does not exist in course %s!" %
(project, course))
self.project = self.course[project]
""" @ivar: shortcut to the project configurations. """
self.project['directory'] = os.path.join(self.course['directory'],
project)
self.name = project
class TurninList:
""" This class represents a list of suffixes for submitted assignments. """
def __init__(self, config_file):
self.config = ConfigObj()
self.config.filename = config_file
self.config.indent_type = ' '
self.config.unrepr = True
self.config.reload()
def write(self, project, suffix):
"""
Write the project submission's suffix to the list file.
@type project: TurninProject
@param project: Project to which we submitted
@type suffix: string
@param suffix: submitted archive's unique suffix
@rtype: None
"""
course = project.course.name
uuid = project.project['uuid']
if not self.config.has_key(course):
self.config[course] = {}
self.config[course][uuid] = suffix
self.config.write()
|