def update_cache(self, src, reference=False):
"""
Update the cache of this element.
src -- the new cache file
reference -- if false (the default) copy the source into this element's cache folder.
if true create a symbolic link to the given source.
the reference is useful for very large cache files, where copying would be a hassle.
"""
if not os.path.exists(src):
raise EnvironmentError("file does not exist: " + src)
cache_filename = os.path.basename(src)
cache_dir = self.get_cache_dir()
cache_filepath = os.path.join(cache_dir, cache_filename)
if not os.path.exists(cache_dir):
pipeline_io.mkdir(cache_dir)
if reference: # TODO: sequences?
ref_path = os.path.normpath(src)
if not ref_path.startswith(self._env.get_project_dir()):
raise EnvironmentError(
"attempted reference is not in the project directory: " +
ref_path)
self._datadict[self.CACHE_FILEPATH] = ref_path
os.symlink(ref_path, cache_filepath)
else:
self._datadict[self.CACHE_FILEPATH] = cache_filepath
if os.path.isdir(src):
shutil.copytree(src, cache_filepath)
else:
shutil.copyfile(src, cache_filepath)
self._update_pipeline_file()
def checkout(self, username):
"""
Copies the element to the given user's work area in a directory with the following name:
{the parent body's name}_{this element's department}_{this element's name}
Adds username to the list of checkout users.
username -- the username (string) of the user performing this action
Returns the absolute filepath to the copied file. If this element has no app file,
the returned filepath will not exist.
"""
checkout_dir = self.get_checkout_dir(username)
if not os.path.exists(checkout_dir):
pipeline_io.mkdir(checkout_dir)
datadict = Checkout.create_new_dict(username, self.get_parent(),
self.get_department(),
self.get_name())
pipeline_io.writefile(
os.path.join(checkout_dir, Checkout.PIPELINE_FILENAME),
datadict)
checkout = Checkout(checkout_dir)
app_file = self.get_app_filepath()
checkout_file = pipeline_io.version_file(
os.path.join(checkout_dir, self.get_app_filename()))
if os.path.exists(app_file):
shutil.copyfile(app_file, checkout_file)
checkout.add_operation(checkout_file)
self.update_checkout_users(username)
return checkout_file
def get_user_workspace(self, username=None):
'''
return the given users workspace. If no user is given, return the current user's workspace.
'''
if username is not None:
workspace = os.path.join(self.get_users_dir, username)
if not os.path.exists(workspace):
pipeline_io.mkdir(workspace)
return workspace
else:
return self._current_user_workspace
def __init__(self, filepath=None):
"""
create an element instance describing the element stored in the given filepath.
if none given, creates an empty instance.
"""
self._env = Environment()
self.app_ext = None
if filepath is not None:
self.load_pipeline_file(filepath)
cache_dir = self.get_cache_dir()
if not os.path.exists(cache_dir):
pipeline_io.mkdir(cache_dir)
else:
self._filepath = None
self._pipeline_file = None
self._datadict = None
def _create_user(self, username):
workspace = os.path.join(self._project_dir, os.path.join(self.get_users_dir(), username))
if not os.path.exists(workspace):
if not pipeline_io.mkdir(workspace):
print("failed to create workspace")
user_pipeline_file = os.path.join(workspace, User.PIPELINE_FILENAME)
if not os.path.exists(user_pipeline_file):
datadict = User.create_new_dict(username)
pipeline_io.writefile(user_pipeline_file, datadict)
class Element:
"""
Abstract class describing elements that make up an asset or shot body.
"""
PIPELINE_FILENAME = ".element"
DEFAULT_NAME = "main"
DEFAULT_CACHE_DIR = "cache"
DEFAULT_RENDER_DIR = "render"
NAME = "name"
PARENT = "parent"
DEPARTMENT = "department"
LATEST_VERSION = "latest_version"
ASSIGNED_USER = "******"
PUBLISHES = "publishes"
START_DATE = "start_date"
END_DATE = "end_date"
APP_EXT = "app_ext"
CACHE_EXT = "cache_ext"
CACHE_FILEPATH = "cache_filepath"
CHECKOUT_USERS = "checkout_users"
NOTES = "notes"
# @staticmethod
def create_new_dict(self, name, department, parent_name):
"""
populate a dictionary with defaults for all the fields needed to create a new element
"""
datadict = {}
datadict[Element.NAME] = name
datadict[Element.PARENT] = parent_name
datadict[Element.DEPARTMENT] = department
datadict[Element.LATEST_VERSION] = -1
datadict[Element.ASSIGNED_USER] = ""
datadict[Element.PUBLISHES] = []
datadict[Element.START_DATE] = ""
datadict[Element.END_DATE] = ""
datadict[Element.APP_EXT] = self.app_ext
datadict[Element.CACHE_EXT] = ""
datadict[Element.CACHE_FILEPATH] = ""
datadict[Element.CHECKOUT_USERS] = []
datadict[Element.NOTES] = []
return datadict
def __init__(self, filepath=None):
"""
create an element instance describing the element stored in the given filepath.
if none given, creates an empty instance.
"""
self._env = Environment()
self.app_ext = None
if filepath is not None:
self.load_pipeline_file(filepath)
cache_dir = self.get_cache_dir()
if not os.path.exists(cache_dir):
pipeline_io.mkdir(cache_dir)
else:
self._filepath = None
self._pipeline_file = None
self._datadict = None
def set_app_ext(self, extension):
self.app_ext = extension
def load_pipeline_file(self, filepath):
"""
load the pipeline file that describes this element
"""
self._filepath = filepath
self._pipeline_file = os.path.join(filepath, self.PIPELINE_FILENAME)
if not os.path.exists(self._pipeline_file):
raise EnvironmentError("not a valid element: " +
self._pipeline_file + " does not exist")
self._datadict = pipeline_io.readfile(self._pipeline_file)
def _update_pipeline_file(self):
pipeline_io.writefile(self._pipeline_file, self._datadict)
def get_name(self):
return self._datadict[self.NAME]
def get_parent(self):
return self._datadict[self.PARENT]
def get_dir(self):
"""
return the directory all data for this element is stored in
"""
return self._filepath
def get_department(self):
return self._datadict[self.DEPARTMENT]
def get_long_name(self):
"""
return a string describing a unique name for this asset:
{the parent body's name}_{this element's department}_{this element's name}
"""
return self.get_parent() + "_" + self.get_department(
) + "_" + self.get_name()
def get_short_name(self):
"""
return a string describing a the name for this asset:
{the parent body's name}_{this element's name}
in this version the department is not included
consider it the name for all parts of the asset
"""
return self.get_parent() + "_" + self.get_name()
def get_assigned_user(self):
"""
returns the username (string) of the assigned user
"""
return self._datadict[self.ASSIGNED_USER]
def get_last_publish(self):
"""
return a tuple describing the latest publish: (username, timestamp, comment, filepath)
"""
latest_version = self._datadict[self.LATEST_VERSION]
if (latest_version < 0):
return None
return self._datadict[self.PUBLISHES][latest_version]
def list_publishes(self):
"""
return a list of tuples describing all publishes for this element.
each tuple contains the following: (username, timestamp, comment, filepath)
"""
return self._datadict[self.PUBLISHES]
def get_last_note(self):
"""
return the latest note created for this element as a string
"""
if (len(self._datadict[self.NOTES]) > 0):
return self._datadict[self.NOTES][-1]
else:
return ""
def list_notes(self):
"""
return a list of all notes that have beeen created for this element
"""
return self._datadict[self.NOTES]
def get_start_date(self):
return self._datadict[self.START_DATE]
def get_end_date(self):
return self._datadict[self.END_DATE]
def get_app_ext(self):
"""
return the extension of the application files for this element (including the period)
e.g. the result for an element that uses maya would return ".mb"
"""
return self._datadict[self.APP_EXT]
def get_app_filename(self):
"""
return the name of the application file for this element. This is just the basename
of the file, not the absolute filepath.
"""
return str(self.get_long_name()) + str(self.get_app_ext())
def get_app_filepath(self):
"""
return the absolute filepath of the application file for this element
"""
filename = self.get_app_filename()
return os.path.join(self._filepath, filename)
def get_version_dir(self, version):
"""
return the path to the directory of the given version
"""
return os.path.join(self._filepath, ".v%04d" % version)
def get_cache_ext(self):
"""
return the extension of the cache files for this element (including the period)
e.g. the result for an element that uses alembic caches would return ".abc"
"""
return self._datadict[self.CACHE_EXT]
def get_cache_dir(self):
# return self._datadict[self.CACHE_FILEPATH]
return os.path.join(self._filepath, self.DEFAULT_CACHE_DIR)
def get_render_dir(self):
render_dir = os.path.join(self._filepath, self.DEFAULT_RENDER_DIR)
if not os.path.exists(render_dir):
pipeline_io.mkdir(render_dir)
return render_dir
def list_checkout_users(self):
"""
return a list of the usernames of all users who have checked out this element
"""
return self._datadict[self.CHECKOUT_USERS]
def update_assigned_user(self, username):
"""
Update the user assigned to this element.
username -- the username (string) of the new user to be assigned
"""
old_username = self._datadict[self.ASSIGNED_USER]
if (old_username == username):
return
self._datadict[self.ASSIGNED_USER] = username
self._update_pipeline_file()
if old_username:
old_user = self._env.get_user(old_username)
if old_user and old_user.has_email():
subject = self.get_long_name() + " reassigned to " + username
message = "you are no longer assigned to " + self.get_long_name(
) + "."
self._env.sendmail([old_user.get_email()], subject, message)
new_user = self._env.get_user(username)
if new_user and new_user.has_email():
subject = self.get_long_name() + " assigned"
message = "you have been assigned to work on " + self.get_long_name(
) + "."
start = self.get_start_date()
if start:
message = message + " you can start on " + start + "."
end = self.get_end_date()
if end:
message = message + " the end date is " + end + "."
note = self.get_last_note()
if note:
message = message + " note: " + note
self._env.sendmail([new_user.get_email()], subject, message)
def update_start_date(self, date):
"""
Update the start date of this element.
date -- the new start date
"""
self._datadict[self.START_DATE] = date
self._update_pipeline_file()
def update_end_date(self, date):
"""
Update the end date of this element.
date -- the new end date
"""
self._datadict[self.END_DATE] = date
self._update_pipeline_file()
def update_checkout_users(self, username):
"""
add the given username to the checkout_users list, if they aren't already in it.
"""
if username not in self._datadict[self.CHECKOUT_USERS]:
self._datadict[self.CHECKOUT_USERS].append(username)
self._update_pipeline_file()
def update_notes(self, note):
"""
add the given note to the note list
"""
self._datadict[self.NOTES].append(note)
self._update_pipeline_file()
def get_checkout_dir(self, username):
"""
return the directory this element would be copied to during checkout for the given username
"""
return os.path.join(self._env.get_users_dir(), username,
self.get_long_name())
def checkout(self, username):
"""
Copies the element to the given user's work area in a directory with the following name:
{the parent body's name}_{this element's department}_{this element's name}
Adds username to the list of checkout users.
username -- the username (string) of the user performing this action
Returns the absolute filepath to the copied file. If this element has no app file,
the returned filepath will not exist.
"""
checkout_dir = self.get_checkout_dir(username)
if not os.path.exists(checkout_dir):
pipeline_io.mkdir(checkout_dir)
datadict = Checkout.create_new_dict(username, self.get_parent(),
self.get_department(),
self.get_name())
pipeline_io.writefile(
os.path.join(checkout_dir, Checkout.PIPELINE_FILENAME),
datadict)
checkout = Checkout(checkout_dir)
app_file = self.get_app_filepath()
checkout_file = pipeline_io.version_file(
os.path.join(checkout_dir, self.get_app_filename()))
if os.path.exists(app_file):
shutil.copyfile(app_file, checkout_file)
checkout.add_operation(checkout_file)
self.update_checkout_users(username)
return checkout_file
def publish(self, username, src, comment, status=None):
"""
Replace the applcation file of this element. Create a new version with the new file.
Store the result of this operation as a new publish.
username -- the username of the user performing this action
src -- a string representing the file to be placed in the new version
comment -- description of changes made in this publish
"""
if not os.path.exists(src):
raise EnvironmentError("file does not exist: " + src)
self._datadict[self.APP_EXT] = os.path.splitext(src)[1]
dst = self.get_app_filepath()
timestamp = pipeline_io.timestamp()
try:
shutil.copyfile(src, dst)
except Exception, e:
print(str(e))
new_version = self._datadict[self.LATEST_VERSION] + 1
self._datadict[self.LATEST_VERSION] = new_version
new_version_dir = self.get_version_dir(new_version)
pipeline_io.mkdir(new_version_dir)
shutil.copy(src, new_version_dir)
# get the filepath for this publish and add it to list of publishes
old_filepath, new_filename = os.path.split(src)
new_publish = os.path.join(new_version_dir, new_filename)
pipeline_io.set_permissions(new_publish)
self._datadict[self.PUBLISHES].append(
(username, timestamp, comment, new_publish))
if status is not None:
pass
self._update_pipeline_file()
dst_addresses = []
for checkout_username in self.list_checkout_users():
try:
checkout_user = self._env.get_user(checkout_username)
except:
print('User ' + str(checkout_username) + ' does not exist.')
continue
if checkout_user and checkout_user.has_email(
) and checkout_username != username:
dst_addresses.append(checkout_user.get_email())
if dst_addresses:
subject = self.get_long_name() + " new publish"
publish_user = self._env.get_user(username)
message = publish_user.get_fullname(
) + " has published a new version of " + self.get_long_name()
if comment != "":
message += "\ncomment: " + comment
self._env.sendmail(dst_addresses, subject, message)
return dst
def get_render_dir(self):
render_dir = os.path.join(self._filepath, self.DEFAULT_RENDER_DIR)
if not os.path.exists(render_dir):
pipeline_io.mkdir(render_dir)
return render_dir