-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathCode.js
More file actions
216 lines (196 loc) · 6.88 KB
/
Code.js
File metadata and controls
216 lines (196 loc) · 6.88 KB
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
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/vacation-calendar
/*
Copyright 2022 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Set the ID of the team calendar to add events to. You can find the calendar's
// ID on the settings page.
const TEAM_CALENDAR_ID = "ENTER_TEAM_CALENDAR_ID_HERE";
// Set the email address of the Google Group that contains everyone in the team.
// Ensure the group has less than 500 members to avoid timeouts.
// Change to an array in order to add indirect members frrm multiple groups, for example:
// let GROUP_EMAIL = ['ENTER_GOOGLE_GROUP_EMAIL_HERE', 'ENTER_ANOTHER_GOOGLE_GROUP_EMAIL_HERE'];
const GROUP_EMAIL = "ENTER_GOOGLE_GROUP_EMAIL_HERE";
const ONLY_DIRECT_MEMBERS = false;
const KEYWORDS = ["vacation", "ooo", "out of office", "offline"];
const MONTHS_IN_ADVANCE = 3;
/**
* Sets up the script to run automatically every hour.
*/
function setup() {
const triggers = ScriptApp.getProjectTriggers();
if (triggers.length > 0) {
throw new Error("Triggers are already setup.");
}
ScriptApp.newTrigger("sync").timeBased().everyHours(1).create();
// Runs the first sync immediately.
sync();
}
/**
* Looks through the group members' public calendars and adds any
* 'vacation' or 'out of office' events to the team calendar.
*/
function sync() {
// Defines the calendar event date range to search.
const today = new Date();
const maxDate = new Date();
maxDate.setMonth(maxDate.getMonth() + MONTHS_IN_ADVANCE);
// Determines the time the the script was last run.
let lastRun = PropertiesService.getScriptProperties().getProperty("lastRun");
lastRun = lastRun ? new Date(lastRun) : null;
// Gets the list of users in the Google Group.
let users = getAllMembers(GROUP_EMAIL);
if (ONLY_DIRECT_MEMBERS) {
users = GroupsApp.getGroupByEmail(GROUP_EMAIL).getUsers();
} else if (Array.isArray(GROUP_EMAIL)) {
users = getUsersFromGroups(GROUP_EMAIL);
}
// For each user, finds events having one or more of the keywords in the event
// summary in the specified date range. Imports each of those to the team
// calendar.
let count = 0;
for (const user of users) {
const username = user.getEmail().split("@")[0];
const events = findEvents(user, today, maxDate, lastRun);
for (const event of events) {
importEvent(username, event);
count++;
}
}
PropertiesService.getScriptProperties().setProperty("lastRun", today);
console.log(`Imported ${count} events`);
}
/**
* Imports the given event from the user's calendar into the shared team
* calendar.
* @param {string} username The team member that is attending the event.
* @param {Calendar.Event} event The event to import.
*/
function importEvent(username, event) {
event.summary = `[${username}] ${event.summary}`;
event.organizer = {
id: TEAM_CALENDAR_ID,
};
event.attendees = [];
// If the event is not of type 'default', it can't be imported, so it needs
// to be changed.
if (event.eventType !== "default") {
event.eventType = "default";
event.outOfOfficeProperties = undefined;
event.focusTimeProperties = undefined;
}
console.log("Importing: %s", event.summary);
try {
Calendar.Events.import(event, TEAM_CALENDAR_ID);
} catch (e) {
console.error(
"Error attempting to import event: %s. Skipping.",
e.toString(),
);
}
}
/**
* In a given user's calendar, looks for occurrences of the given keyword
* in events within the specified date range and returns any such events
* found.
* @param {Session.User} user The user to retrieve events for.
* @param {string} keyword The keyword to look for.
* @param {Date} start The starting date of the range to examine.
* @param {Date} end The ending date of the range to examine.
* @param {Date} optSince A date indicating the last time this script was run.
* @return {Calendar.Event[]} An array of calendar events.
*/
function findEvents(user, start, end, optSince) {
const params = {
eventTypes: "outOfOffice",
timeMin: formatDateAsRFC3339(start),
timeMax: formatDateAsRFC3339(end),
showDeleted: true,
};
if (optSince) {
// This prevents the script from examining events that have not been
// modified since the specified date (that is, the last time the
// script was run).
params.updatedMin = formatDateAsRFC3339(optSince);
}
let pageToken = null;
let events = [];
do {
params.pageToken = pageToken;
let response;
try {
response = Calendar.Events.list(user.getEmail(), params);
} catch (e) {
console.error(
"Error retriving events for %s, %s: %s; skipping",
user,
keyword,
e.toString(),
);
continue;
}
events = events.concat(response.items);
pageToken = response.nextPageToken;
} while (pageToken);
return events;
}
/**
* Returns an RFC3339 formated date String corresponding to the given
* Date object.
* @param {Date} date a Date.
* @return {string} a formatted date string.
*/
function formatDateAsRFC3339(date) {
return Utilities.formatDate(date, "UTC", "yyyy-MM-dd'T'HH:mm:ssZ");
}
/**
* Get both direct and indirect members (and delete duplicates).
* @param {string} the e-mail address of the group.
* @return {object} direct and indirect members.
*/
function getAllMembers(groupEmail) {
const group = GroupsApp.getGroupByEmail(groupEmail);
let users = group.getUsers();
const childGroups = group.getGroups();
for (let i = 0; i < childGroups.length; i++) {
const childGroup = childGroups[i];
users = users.concat(getAllMembers(childGroup.getEmail()));
}
// Remove duplicate members
const uniqueUsers = [];
const userEmails = {};
for (let i = 0; i < users.length; i++) {
const user = users[i];
if (!userEmails[user.getEmail()]) {
uniqueUsers.push(user);
userEmails[user.getEmail()] = true;
}
}
return uniqueUsers;
}
/**
* Get indirect members from multiple groups (and delete duplicates).
* @param {array} the e-mail addresses of multiple groups.
* @return {object} indirect members of multiple groups.
*/
function getUsersFromGroups(groupEmails) {
const users = [];
for (const groupEmail of groupEmails) {
const groupUsers = GroupsApp.getGroupByEmail(groupEmail).getUsers();
for (const user of groupUsers) {
if (!users.some((u) => u.getEmail() === user.getEmail())) {
users.push(user);
}
}
}
return users;
}