discourse-calendar/plugin.rb

379 lines
12 KiB
Ruby

# frozen_string_literal: true
# name: discourse-calendar
# about: Display a calendar in the first post of a topic
# version: 0.2
# author: Daniel Waterworth, Joffrey Jaffeux
# url: https://github.com/discourse/discourse-calendar
gem "holidays", "8.0.0", require: false
load File.expand_path("../lib/calendar_settings_validator.rb", __FILE__)
enabled_site_setting :calendar_enabled
register_asset "stylesheets/vendor/fullcalendar.min.css"
register_asset "stylesheets/common/discourse-calendar.scss"
register_asset "stylesheets/common/events-calendar.scss"
register_asset "stylesheets/common/discourse-post-event.scss"
register_asset "stylesheets/common/discourse-post-event-preview.scss"
register_asset "stylesheets/common/discourse-post-event-builder.scss"
register_asset "stylesheets/common/discourse-post-event-invitees.scss"
register_asset "stylesheets/common/discourse-post-event-upcoming-events.scss"
register_asset "stylesheets/common/discourse-post-event-core-ext.scss"
register_asset "stylesheets/mobile/discourse-calendar.scss", :mobile
register_asset "stylesheets/mobile/discourse-post-event.scss", :mobile
register_asset "stylesheets/desktop/discourse-calendar.scss", :desktop
register_svg_icon "fas fa-calendar-day"
register_svg_icon "fas fa-question"
register_svg_icon "fas fa-clock"
register_svg_icon "fas fa-clock"
register_svg_icon "fas fa-star"
after_initialize do
module ::DiscourseCalendar
PLUGIN_NAME ||= "discourse-calendar"
# Type of calendar ('static' or 'dynamic')
CALENDAR_CUSTOM_FIELD ||= "calendar"
# User custom field set when user is on holiday
HOLIDAY_CUSTOM_FIELD ||= "on_holiday"
# List of all users on holiday
USERS_ON_HOLIDAY_KEY ||= "users_on_holiday"
# User region used in finding holidays
REGION_CUSTOM_FIELD ||= "holidays-region"
# List of groups
GROUP_TIMEZONES_CUSTOM_FIELD ||= "group-timezones"
def self.users_on_holiday
PluginStore.get(PLUGIN_NAME, USERS_ON_HOLIDAY_KEY)
end
def self.users_on_holiday=(usernames)
PluginStore.set(PLUGIN_NAME, USERS_ON_HOLIDAY_KEY, usernames)
end
class Engine < ::Rails::Engine
engine_name PLUGIN_NAME
isolate_namespace DiscourseCalendar
end
end
module ::DiscoursePostEvent
PLUGIN_NAME ||= "discourse-post-event"
# Topic where op has a post event custom field
TOPIC_POST_EVENT_STARTS_AT ||= "TopicEventStartsAt"
class Engine < ::Rails::Engine
engine_name PLUGIN_NAME
isolate_namespace DiscoursePostEvent
end
end
# DISCOURSE POST EVENT
[
"../app/controllers/discourse_post_event_controller.rb",
"../app/controllers/discourse_post_event/invitees_controller.rb",
"../app/controllers/discourse_post_event/events_controller.rb",
"../app/controllers/discourse_post_event/upcoming_events_controller.rb",
"../app/models/discourse_post_event/event.rb",
"../app/models/discourse_post_event/invitee.rb",
"../lib/discourse_post_event/event_parser.rb",
"../lib/discourse_post_event/event_validator.rb",
"../lib/discourse_post_event/event_finder.rb",
"../app/serializers/discourse_post_event/invitee_serializer.rb",
"../app/serializers/discourse_post_event/event_serializer.rb"
].each { |path| load File.expand_path(path, __FILE__) }
::ActionController::Base.prepend_view_path File.expand_path("../app/views", __FILE__)
Discourse::Application.routes.append do
mount ::DiscoursePostEvent::Engine, at: '/'
end
DiscoursePostEvent::Engine.routes.draw do
get '/discourse-post-event/events' => 'events#index', constraints: { format: /(json|ics)/ }
get '/discourse-post-event/events/:id' => 'events#show'
delete '/discourse-post-event/events/:id' => 'events#destroy'
post '/discourse-post-event/events' => 'events#create'
put '/discourse-post-event/events/:id' => 'events#update'
post '/discourse-post-event/events/:id/invite' => 'events#invite'
put '/discourse-post-event/invitees/:id' => 'invitees#update'
post '/discourse-post-event/invitees' => 'invitees#create'
get '/discourse-post-event/invitees' => 'invitees#index'
get '/upcoming-events' => 'upcoming_events#index'
end
reloadable_patch do
require 'post'
class ::Post
has_one :event,
dependent: :destroy,
class_name: 'DiscoursePostEvent::Event',
foreign_key: :id
validate :valid_event
def valid_event
return unless self.raw_changed?
validator = DiscoursePostEvent::EventValidator.new(self)
validator.validate_event
end
end
end
add_to_class(:user, :can_create_discourse_post_event?) do
return @can_create_discourse_post_event if defined?(@can_create_discourse_post_event)
@can_create_discourse_post_event = begin
return true if staff?
allowed_groups = SiteSetting.discourse_post_event_allowed_on_groups.split('|').compact
allowed_groups.present? && groups.where(id: allowed_groups).exists?
rescue
false
end
end
add_to_class(:guardian, :can_act_on_invitee?) do |invitee|
user && (user.staff? || user.id == invitee.user_id)
end
add_to_class(:guardian, :can_create_discourse_post_event?) { user && user.can_create_discourse_post_event? }
add_to_serializer(:current_user, :can_create_discourse_post_event) do
object.can_create_discourse_post_event?
end
add_to_class(:user, :can_act_on_discourse_post_event?) do |event|
return @can_act_on_discourse_post_event if defined?(@can_act_on_discourse_post_event)
@can_act_on_discourse_post_event = begin
return true if admin?
can_create_discourse_post_event? && event.post.user_id == id
rescue
false
end
end
add_to_class(:guardian, :can_act_on_discourse_post_event?) { |event| user && user.can_act_on_discourse_post_event?(event) }
add_class_method(:group, :discourse_post_event_allowed_groups) do
where(id: SiteSetting.discourse_post_event_allowed_on_groups.split('|').compact)
end
add_to_serializer(:post, :event) do
DiscoursePostEvent::EventSerializer.new(object.event, scope: scope, root: false)
end
add_to_serializer(:post, :include_event?) do
SiteSetting.discourse_post_event_enabled
end
on(:post_process_cooked) do |doc, post|
DiscoursePostEvent::Event.update_from_raw(post)
end
on(:post_destroyed) do |post|
if SiteSetting.discourse_post_event_enabled && post.event
post.event.update!(deleted_at: Time.now)
end
end
on(:post_recovered) do |post|
if SiteSetting.discourse_post_event_enabled && post.event
post.event.update!(deleted_at: nil)
end
end
TopicList.preloaded_custom_fields << DiscoursePostEvent::TOPIC_POST_EVENT_STARTS_AT
add_to_serializer(:topic_view, :event_starts_at, false) do
object.topic.custom_fields[DiscoursePostEvent::TOPIC_POST_EVENT_STARTS_AT]
end
add_to_serializer(:topic_view, 'include_event_starts_at?') do
SiteSetting.discourse_post_event_enabled &&
SiteSetting.display_post_event_date_on_topic_title &&
object
.topic
.custom_fields
.keys
.include?(DiscoursePostEvent::TOPIC_POST_EVENT_STARTS_AT)
end
add_to_class(:topic, :event_starts_at) do
@event_starts_at ||= custom_fields[DiscoursePostEvent::TOPIC_POST_EVENT_STARTS_AT]
end
add_to_serializer(:topic_list_item, :event_starts_at, false) do
object.event_starts_at
end
add_to_serializer(:topic_list_item, 'include_event_starts_at?') do
SiteSetting.discourse_post_event_enabled &&
SiteSetting.display_post_event_date_on_topic_title &&
object.event_starts_at
end
# DISCOURSE CALENDAR
[
"../app/models/calendar_event.rb",
"../app/serializers/user_timezone_serializer.rb",
"../jobs/scheduled/create_holiday_events.rb",
"../jobs/scheduled/destroy_past_events.rb",
"../jobs/scheduled/update_holiday_usernames.rb",
"../lib/calendar_validator.rb",
"../lib/calendar.rb",
"../lib/event_validator.rb",
"../lib/group_timezones.rb",
"../lib/time_sniffer.rb",
].each { |path| load File.expand_path(path, __FILE__) }
register_post_custom_field_type(DiscourseCalendar::CALENDAR_CUSTOM_FIELD, :string)
register_post_custom_field_type(DiscourseCalendar::GROUP_TIMEZONES_CUSTOM_FIELD, :json)
TopicView.default_post_custom_fields << DiscourseCalendar::GROUP_TIMEZONES_CUSTOM_FIELD
register_user_custom_field_type(DiscourseCalendar::HOLIDAY_CUSTOM_FIELD, :boolean)
whitelist_staff_user_custom_field(DiscourseCalendar::HOLIDAY_CUSTOM_FIELD)
on(:site_setting_changed) do |name, old_value, new_value|
next unless [:all_day_event_start_time, :all_day_event_end_time].include? name
Post.where(id: CalendarEvent.select(:post_id).distinct).each do |post|
CalendarEvent.update(post)
end
end
on(:post_process_cooked) do |doc, post|
DiscourseCalendar::Calendar.update(post)
DiscourseCalendar::GroupTimezones.update(post)
CalendarEvent.update(post)
end
on(:post_recovered) do |post, _, _|
DiscourseCalendar::Calendar.update(post)
DiscourseCalendar::GroupTimezones.update(post)
CalendarEvent.update(post)
end
on(:post_destroyed) do |post, _, _|
DiscourseCalendar::Calendar.destroy(post)
CalendarEvent.where(post_id: post.id).destroy_all
end
validate(:post, :validate_calendar) do |force = nil|
return unless self.raw_changed? || force
validator = DiscourseCalendar::CalendarValidator.new(self)
validator.validate_calendar
end
validate(:post, :validate_event) do |force = nil|
return unless self.raw_changed? || force
return if self.is_first_post?
# Skip if not a calendar topic
return if !self&.topic&.first_post&.custom_fields&.[](DiscourseCalendar::CALENDAR_CUSTOM_FIELD)
validator = DiscourseCalendar::EventValidator.new(self)
validator.validate_event
end
Post.class_eval do
def has_group_timezones?
custom_fields[DiscourseCalendar::GROUP_TIMEZONES_CUSTOM_FIELD].present?
end
def group_timezones
custom_fields[DiscourseCalendar::GROUP_TIMEZONES_CUSTOM_FIELD] || {}
end
def group_timezones=(val)
if val.present?
custom_fields[DiscourseCalendar::GROUP_TIMEZONES_CUSTOM_FIELD] = val
else
custom_fields.delete(DiscourseCalendar::GROUP_TIMEZONES_CUSTOM_FIELD)
end
end
end
add_to_serializer(:post, :calendar_details) do
result = []
grouped_events = {}
CalendarEvent.where(topic_id: object.topic_id).each do |event|
# Events with no `post_id` are holidays
if event.post_id
result << {
type: :standalone,
post_number: event.post_number,
message: event.description,
from: event.start_date,
to: event.end_date,
username: event.username,
recurring: event.recurrence,
post_url: Post.url('-', event.topic_id, event.post_number)
}
else
identifier = "#{event.region.split("_").first}-#{event.description}-#{event.start_date.strftime("%W")}"
if grouped_events[identifier]
grouped_events[identifier][:to] = event.start_date
else
grouped_events[identifier] = {
type: :grouped,
name: event.description,
from: event.start_date,
usernames: []
}
end
grouped_events[identifier][:usernames] << event.username
grouped_events[identifier][:usernames].uniq!
end
end
result.concat(grouped_events.values)
end
add_to_serializer(:post, :include_calendar_details?) do
object.is_first_post?
end
add_to_serializer(:post, :group_timezones) do
result = {}
group_names = object.group_timezones["groups"] || []
if group_names.present?
users = User
.joins(:groups, :user_option)
.where("groups.name": group_names)
.select("users.*", "groups.name AS group_name", "user_options.timezone")
users.each do |u|
result[u.group_name] ||= []
result[u.group_name] << UserTimezoneSerializer.new(u, root: false).as_json
end
end
result
end
add_to_serializer(:post, :include_group_timezones?) do
object.group_timezones.present?
end
add_to_serializer(:site, :users_on_holiday) do
DiscourseCalendar.users_on_holiday
end
add_to_serializer(:site, :include_users_on_holiday?) do
scope.is_staff?
end
end