class Project(ProjectContactDetailMixin,
ProjectLocationMixin,
base.TimeStampedModel):
slug = AutoSlugField(populate_from='name', unique=True)
name = models.CharField(
max_length=120,
verbose_name=_('Title of your project'),
help_text=_('This title will appear on the '
'teaser card and on top of the project '
'detail page. It should be max. 120 characters long')
)
organisation = models.ForeignKey(
settings.A4_ORGANISATIONS_MODEL,
on_delete=models.CASCADE)
group = models.ForeignKey(
Group,
on_delete=models.SET_NULL,
blank=True,
null=True)
description = models.CharField(
max_length=250,
verbose_name=_('Short description of your project'),
help_text=_('This short description will appear on '
'the header of the project and in the teaser. '
'It should briefly state the goal of the project '
'in max. 250 chars.')
)
information = RichTextCollapsibleUploadingField(
blank=True,
config_name='collapsible-image-editor',
verbose_name=_('Description of your project'),
help_text=_('This description should tell participants '
'what the goal of the project is, how the project’s '
'participation will look like. It will be always visible '
'in the „Info“ tab on your project’s page.')
)
result = RichTextUploadingField(
blank=True,
config_name='image-editor',
verbose_name=_('Results of your project'),
help_text=_('Here you should explain what the expected outcome of the '
'project will be and how you are planning to use the '
'results. If the project is finished you should add a '
'summary of the results.')
)
is_public = models.BooleanField(
default=True,
verbose_name=_('Access to the project'),
help_text=_('Please indicate whether this project should be public '
'or restricted to invited users. Teasers for your project '
'including title and short description will always be '
'visible to everyone')
)
is_draft = models.BooleanField(default=True)
image = fields.ConfiguredImageField(
'heroimage',
verbose_name=_('Header image'),
help_prefix=_(
'The image will be shown as a decorative background image.'
),
upload_to='projects/backgrounds',
blank=True)
image_copyright = fields.ImageCopyrightField(image_name=_('Header image'))
tile_image = fields.ConfiguredImageField(
'tileimage',
verbose_name=_('Tile image'),
help_prefix=_(
'The image will be shown in the project tile.'
),
upload_to='projects/tiles',
blank=True)
tile_image_copyright = fields.ImageCopyrightField(
image_name=_('Tile image'))
participants = models.ManyToManyField(
settings.AUTH_USER_MODEL,
related_name='project_participant',
blank=True,
)
moderators = models.ManyToManyField(
settings.AUTH_USER_MODEL,
related_name='project_moderator',
blank=True,
)
is_archived = models.BooleanField(
default=False,
verbose_name=_('Project is archived'),
help_text=_('Exclude this project from all listings by default. '
'You can still access this project by using filters.'),
)
topics = TopicField(
verbose_name=_('Project topics'),
help_text=_('Add topics to your project.')
)
objects = ProjectManager()
class Meta:
ordering = ['-created']
def __str__(self):
return self.name
def save(self, *args, **kwargs):
self.information = html_transforms.clean_html_field(
self.information, 'collapsible-image-editor')
self.result = html_transforms.clean_html_field(
self.result, 'image-editor')
super(Project, self).save(*args, **kwargs)
def get_absolute_url(self):
return reverse('project-detail', kwargs=dict(slug=self.slug))
def has_member(self, user):
"""
Everybody is member of all public projects and private projects can
be joined as moderator or participant.
"""
return (
(user.is_authenticated and self.is_public)
or (user in self.participants.all())
or (user in self.moderators.all())
)
def is_group_member(self, user):
if self.group:
return user.groups.filter(id=self.group.id).exists()
return False
def has_moderator(self, user):
return user in self.moderators.all()
@cached_property
def topic_names(self):
if hasattr(settings, 'A4_PROJECT_TOPICS'):
choices = dict(settings.A4_PROJECT_TOPICS)
return [choices[topic] for topic in self.topics]
return []
@cached_property
def other_projects(self):
other_projects = self.organisation.project_set\
.filter(is_draft=False, is_archived=False).exclude(slug=self.slug)
return other_projects
@cached_property
def is_private(self):
return not self.is_public
@cached_property
def last_active_phase(self):
"""
Return the last active phase.
The last active phase is defined as the phase that out of all past
and currently active phases started last.
This property is used to determine which phase view is shown.
"""
return self.phases\
.past_and_active_phases()\
.last()
@cached_property
def last_active_module(self):
"""
Return the module of the last active phase.
Attention: Might be _deprecated_ and replaced by logic coming from
the modules.
"""
last_active_phase = self.last_active_phase
if last_active_phase:
return last_active_phase.module
return None
@cached_property
def active_phase(self):
"""
Return the currently active phase.
The currently active phase is defined as the phase that out of all
currently active phases started last. This is analogous to the last
active phase.
Attention: This method is _deprecated_ as multiple phases (in
different modules) may be active at the same time.
"""
warnings.warn(
"active_phase is deprecated; "
"use active_phase_ends_next or active_module_ends_next",
DeprecationWarning
)
last_active_phase = self.last_active_phase
if last_active_phase and not last_active_phase.is_over:
return last_active_phase
return None
@cached_property
def active_phase_ends_next(self):
"""
Return the currently active phase that ends next.
"""
return self.phases.active_phases().order_by('end_date').first()
@cached_property
def days_left(self):
"""
Return the number of days left in the currently active phase.
Attention: This method is _deprecated_ as multiple phases may be
active at the same time.
"""
warnings.warn(
"days_left is deprecated as it relies on active_phase; "
"use module_running_days_left",
DeprecationWarning
)
active_phase = self.active_phase
if active_phase:
today = timezone.now().replace(hour=0, minute=0, second=0)
time_delta = active_phase.end_date - today
return time_delta.days
return None
@cached_property
def time_left(self):
"""
Return the time left in the currently active phase that ends next.
Attention: _deprecated_ as in the projects logic from the modules
should be used.
"""
warnings.warn(
"time_left is deprecated as in the projects "
"logic from the modules should be used; "
"use module_running_time_left",
DeprecationWarning
)
def seconds_in_units(seconds):
unit_totals = []
unit_limits = [
([_('day'), _('days')], 24 * 3600),
([_('hour'), _('hours')], 3600),
([_('minute'), _('minutes')], 60)
]
for unit_name, limit in unit_limits:
if seconds >= limit:
amount = int(float(seconds) / limit)
if amount > 1:
unit_totals.append((unit_name[1], amount))
else:
unit_totals.append((unit_name[0], amount))
seconds = seconds - (amount * limit)
return unit_totals
active_phase = self.active_phase_ends_next
if active_phase:
today = timezone.now()
time_delta = active_phase.end_date - today
seconds = time_delta.total_seconds()
time_delta_list = seconds_in_units(seconds)
best_unit = time_delta_list[0]
time_delta_str = '{} {}'.format(str(best_unit[1]),
str(best_unit[0]))
return time_delta_str
@cached_property
def active_phase_progress(self):
"""
Return the progress of the currently active phase that ends next
in percent.
Attention: _deprecated_ as in the projects logic from the modules
should be used.
"""
warnings.warn(
"active_phase_progress is deprecated as in the projects "
"logic from the modules should be used; "
"use module_running_progress",
DeprecationWarning
)
active_phase = self.active_phase_ends_next
if active_phase:
time_gone = timezone.now() - active_phase.start_date
total_time = active_phase.end_date - active_phase.start_date
return round(time_gone / total_time * 100)
return None
@cached_property
def phases(self):
from adhocracy4.phases import models as phase_models
return phase_models.Phase.objects.filter(module__project=self)
@cached_property
def future_phases(self):
return self.phases.future_phases()
@cached_property
def past_phases(self):
return self.phases.past_phases()
@cached_property
def has_started(self):
return self.phases.past_and_active_phases().exists()
@cached_property
def end_date(self):
last_phase = self.phases.exclude(end_date=None)\
.order_by('end_date').last()
end_date = last_phase.end_date
if self.events:
last_event = self.events.order_by('date').last()
if last_event.date > end_date:
end_date = last_event.date
return end_date
@cached_property
def events(self):
if hasattr(self, 'offlineevent_set'):
return self.offlineevent_set.all()
@cached_property
def has_future_events(self):
if self.events:
now = timezone.now()
return self.events.filter(date__gt=now).exists()
return False
@cached_property
def has_finished(self):
return not self.phases.active_phases().exists()\
and not self.phases.future_phases().exists()\
and not self.has_future_events
@cached_property
def modules(self):
return self.module_set.all()
@cached_property
def running_modules(self):
return self.modules.running_modules()
@cached_property
def running_module_ends_next(self):
"""
Return the currently active module that ends next.
"""
return self.running_modules.order_by('module_end').first()
@cached_property
def past_modules(self):
"""Return past modules ordered by start."""
return self.modules.past_modules()
@cached_property
def future_modules(self):
"""
Return future modules ordered by start date.
Note: Modules without a start date are assumed to start in the future.
"""
return self.modules.future_modules()
@cached_property
def module_running_days_left(self):
"""
Return the number of days left in the currently running module that
ends next.
Attention: It's a bit coarse and should only be used for estimations
like 'ending soon', but NOT to display the number of days a project
is still running. For that use module_running_time_left.
"""
running_module = self.running_module_ends_next
if running_module:
today = timezone.now().replace(hour=0, minute=0, second=0)
time_delta = running_module.module_end - today
return time_delta.days
return None
@cached_property
def module_running_time_left(self):
"""
Return the time left in the currently running module that ends next.
"""
running_module = self.running_module_ends_next
if running_module:
return running_module.module_running_time_left
return None
@cached_property
def module_running_progress(self):
"""
Return the progress of the currently running module that ends next
in percent.
"""
running_module = self.running_module_ends_next
if running_module:
return running_module.module_running_progress
return None
@cached_property
def is_archivable(self):
return not self.is_archived and self.has_finished
class Project(base.TimeStampedModel):
slug = AutoSlugField(populate_from='name', unique=True)
name = models.CharField(
max_length=120,
verbose_name=_('Title of your project'),
help_text=_('This title will appear on the '
'teaser card and on top of the project '
'detail page. It should be max. 120 characters long'))
organisation = models.ForeignKey(settings.A4_ORGANISATIONS_MODEL,
on_delete=models.CASCADE)
description = models.CharField(
max_length=250,
verbose_name=_('Short description of your project'),
help_text=_('This short description will appear on '
'the header of the project and in the teaser. '
'It should briefly state the goal of the project '
'in max. 250 chars.'))
information = RichTextCollapsibleUploadingField(
blank=True,
config_name='collapsible-image-editor',
verbose_name=_('Description of your project'),
help_text=_('This description should tell participants '
'what the goal of the project is, how the project’s '
'participation will look like. It will be always visible '
'in the „Info“ tab on your project’s page.'))
result = RichTextUploadingField(
blank=True,
config_name='image-editor',
verbose_name=_('Results of your project'),
help_text=_('Here you should explain what the expected outcome of the '
'project will be and how you are planning to use the '
'results. If the project is finished you should add a '
'summary of the results.'))
is_public = models.BooleanField(
default=True,
verbose_name=_('Access to the project'),
help_text=_('Please indicate whether this project should be public '
'or restricted to invited users. Teasers for your project '
'including title and short description will always be '
'visible to everyone'))
is_draft = models.BooleanField(default=True)
image = fields.ConfiguredImageField(
'heroimage',
verbose_name=_('Header image'),
help_prefix=_(
'The image will be shown as a decorative background image.'),
upload_to='projects/backgrounds',
blank=True)
image_copyright = fields.ImageCopyrightField(image_name=_('Header image'))
tile_image = fields.ConfiguredImageField(
'tileimage',
verbose_name=_('Tile image'),
help_prefix=_('The image will be shown in the project tile.'),
upload_to='projects/tiles',
blank=True)
tile_image_copyright = fields.ImageCopyrightField(
image_name=_('Tile image'))
participants = models.ManyToManyField(
settings.AUTH_USER_MODEL,
related_name='project_participant',
blank=True,
)
moderators = models.ManyToManyField(
settings.AUTH_USER_MODEL,
related_name='project_moderator',
blank=True,
)
is_archived = models.BooleanField(
default=False,
verbose_name=_('Project is archived'),
help_text=_('Exclude this project from all listings by default. '
'You can still access this project by using filters.'),
)
objects = ProjectManager()
class Meta:
ordering = ['-created']
def __str__(self):
return self.name
def save(self, *args, **kwargs):
self.information = html_transforms.clean_html_field(
self.information, 'collapsible-image-editor')
self.result = html_transforms.clean_html_field(self.result,
'image-editor')
super(Project, self).save(*args, **kwargs)
def get_absolute_url(self):
return reverse('project-detail', kwargs=dict(slug=self.slug))
def has_member(self, user):
"""
Everybody is member of all public projects and private projects can
be joined as moderator or participant.
"""
return ((user.is_authenticated() and self.is_public)
or (user in self.participants.all())
or (user in self.moderators.all()))
def has_moderator(self, user):
return user in self.moderators.all()
@property
def other_projects(self):
other_projects = self.organisation.project_set\
.filter(is_draft=False, is_archived=False).exclude(slug=self.slug)
return other_projects
@property
def is_private(self):
return not self.is_public
@property
def modules(self):
return self.module_set.all()
@property
def last_active_phase(self):
"""
Return the last active phase.
The last active phase is defined as the phase that out of all past
and currently active phases started last.
"""
return self.phases\
.past_and_active_phases()\
.last()
@property
def last_active_module(self):
"""Return the module of the last active phase."""
last_active_phase = self.last_active_phase
if last_active_phase:
return last_active_phase.module
return None
@property
def active_phase(self):
"""
Return the currently active phase.
The currently active phase is defined as the phase that out of all
currently active phases started last. This is analogous to the last
active phase.
Attention: This method is _deprecated_ as multiple phases may be
active at the same time.
"""
last_active_phase = self.last_active_phase
if last_active_phase and not last_active_phase.is_over:
return last_active_phase
return None
@property
def days_left(self):
"""
Return the number of days left in the currently active phase.
Attention: This method is _deprecated_ as multiple phases may be
active at the same time.
"""
active_phase = self.active_phase
if active_phase:
today = timezone.now().replace(hour=0, minute=0, second=0)
time_delta = active_phase.end_date - today
return time_delta.days
return None
@property
def phases(self):
from adhocracy4.phases import models as phase_models
return phase_models.Phase.objects.filter(module__project=self)
@property
def future_phases(self):
return self.phases.future_phases()
@property
def past_phases(self):
return self.phases.past_phases()
@property
def has_started(self):
return self.phases.past_and_active_phases().exists()
@property
def has_finished(self):
return not self.phases.active_phases().exists()\
and not self.phases.future_phases().exists()
@property
def is_archivable(self):
return not self.is_archived and self.has_finished