GoogleDriveFileList/FileAudit at main · jlotterer/GoogleDriveFileList · GitHub

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
// File: Code.gs

function onOpen() {
  SpreadsheetApp.getUi()
    .createMenu('File Audit')
    .addItem('Run File Audit', 'showAuditDialog')
    .addToUi();
}

function showAuditDialog() {
  const html = HtmlService.createHtmlOutput(`
    <!DOCTYPE html>
    <html>
      <head>
        <base target="_top">
        <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
        <link href="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0/css/materialize.min.css" rel="stylesheet">
        <script src="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0/js/materialize.min.js"></script>
        <style>
          .spinner {
            border: 4px solid #f3f3f3;
            border-top: 4px solid #3498db;
            border-radius: 50%;
            width: 30px;
            height: 30px;
            animation: spin 1s linear infinite;
            display: none;
            margin: 10px auto;
          }
          @keyframes spin {
            0% { transform: rotate(0deg); }
            100% { transform: rotate(360deg); }
          }
        </style>
        <script>
          function startAudit() {
            const form = document.getElementById('auditForm');
            const formData = new FormData(form);
            document.getElementById('spinner').style.display = 'block';
            document.getElementById('startAuditBtn').disabled = true;
            document.getElementById('closeBtn').disabled = true;
            document.getElementById('progressBar').style.display = 'block';
            document.getElementById('message').innerHTML = '';
            google.script.run
              .withSuccessHandler(function(result) {
                document.getElementById('message').innerHTML = result.message;
                document.getElementById('message').style.color = 'green';
                checkProgress();
              })
              .withFailureHandler(function(error) {
                document.getElementById('spinner').style.display = 'none';
                document.getElementById('startAuditBtn').disabled = false;
                document.getElementById('closeBtn').disabled = false;
                document.getElementById('message').innerHTML = 'Error: ' + error.message;
                document.getElementById('message').style.color = 'red';
              })
              .startAudit(Object.fromEntries(formData));
          }

          function checkProgress() {
            google.script.run
              .withSuccessHandler(updateProgressBar)
              .getAuditProgress();
          }

          function updateProgressBar(progress) {
            const fill = document.getElementById('progressBarFill');
            fill.style.width = progress + '%';
            fill.innerHTML = progress + '%';
            if (progress < 100) {
              setTimeout(checkProgress, 5000); // Check every 5 seconds
            } else {
              document.getElementById('spinner').style.display = 'none';
              document.getElementById('startAuditBtn').disabled = false;
              document.getElementById('closeBtn').disabled = false;
              document.getElementById('message').innerHTML = 'Audit complete! Check the "File Audit Results" sheet.';
            }
          }

          function closeDialog() {
            google.script.host.close();
          }
        </script>
      </head>
      <body>
        <div class="container">
          <form id="auditForm" class="col s12">
            <div class="input-field">
              <input type="text" id="folderId" name="folderId" placeholder="1SQKoQSnqmrdzjGXFISDjCJg2Sbg2GYga" required>
              <label for="folderId">Root Folder ID</label>
            </div>
            <p>Item Type:</p>
            <p>
              <label>
                <input name="itemType" type="radio" value="all" checked/>
                <span>Both Files and Folders</span>
              </label>
            </p>
            <p>
              <label>
                <input name="itemType" type="radio" value="files"/>
                <span>Files Only</span>
              </label>
            </p>
            <p>
              <label>
                <input name="itemType" type="radio" value="folders"/>
                <span>Folders Only</span>
              </label>
            </p>
            <p>
              <label>
                <input type="checkbox" name="recursive" value="true"/>
                <span>Include Subfolders (Recursive)</span>
              </label>
            </p>
            <p>Filter By:</p>
            <p>
              <label>
                <input type="checkbox" name="filterOwners" value="true"/>
                <span>Owners</span>
              </label>
            </p>
            <p>
              <label>
                <input type="checkbox" name="filterEditors" value="true"/>
                <span>Editors</span>
              </label>
            </p>
            <p>
              <label>
                <input type="checkbox" name="filterCommenters" value="true"/>
                <span>Commenters</span>
              </label>
            </p>
            <p>
              <label>
                <input type="checkbox" name="filterViewers" value="true"/>
                <span>Viewers</span>
              </label>
            </p>
            <div class="input-field">
              <textarea name="emails" class="materialize-textarea" rows="3" cols="40"></textarea>
              <label>Email addresses (comma-separated, for filtering)</label>
            </div>
            <p>
              <label>
                <input type="checkbox" name="removePermissions" value="true"/>
                <span>Remove permissions for listed emails</span>
              </label>
            </p>
            <div class="center-align">
              <a id="startAuditBtn" class="waves-effect waves-light btn" onclick="startAudit()">Start Audit</a>
              <a id="closeBtn" class="waves-effect waves-light btn" onclick="closeDialog()">Close</a>
            </div>
          </form>
          <div id="spinner" class="spinner"></div>
          <div id="progressBar" class="progress" style="display:none;">
            <div id="progressBarFill" class="determinate" style="width: 0%;">0%</div>
          </div>
          <div id="message" style="margin-top: 10px; text-align: center;"></div>
        </div>
      </body>
    </html>
  `).setWidth(400).setHeight(750);

  SpreadsheetApp.getUi().showModalDialog(html, 'File Audit Options');
}

function startAudit(options) {
  const props = PropertiesService.getScriptProperties();

  // Parse emails into an array
  options.emails = options.emails ? options.emails.split(',').map(e => e.trim()) : [];

  // Convert checkbox values to booleans
  options.recursive = options.recursive === 'true';
  options.filterOwners = options.filterOwners === 'true';
  options.filterEditors = options.filterEditors === 'true';
  options.filterCommenters = options.filterCommenters === 'true';
  options.filterViewers = options.filterViewers === 'true';
  options.removePermissions = options.removePermissions === 'true';

  props.setProperty('auditOptions', JSON.stringify(options));
  props.setProperty('auditProgress', '0');
  props.deleteProperty('pageToken');
  props.deleteProperty('folderStack');

  // Start the audit process
  continueAudit();

  return { message: "Audit started. Check the 'File Audit Results' sheet for progress." };
}

function continueAudit() {
  const props = PropertiesService.getScriptProperties();
  const options = JSON.parse(props.getProperty('auditOptions'));
  const pageToken = props.getProperty('pageToken');
  let folderStack = JSON.parse(props.getProperty('folderStack') || '[]');

  const result = processNextBatch(options, pageToken, folderStack);

  if (result.nextPageToken || result.folderStack.length > 0) {
    props.setProperty('pageToken', result.nextPageToken || '');
    props.setProperty('folderStack', JSON.stringify(result.folderStack));
    // Schedule next batch
    ScriptApp.newTrigger('continueAudit')
      .timeBased()
      .everyMinutes(1)
      .create();
  } else {
    // Audit complete
    props.deleteProperty('auditOptions');
    props.deleteProperty('pageToken');
    props.deleteProperty('folderStack');
    props.setProperty('auditProgress', '100');
  }
}

function processNextBatch(options, pageToken, folderStack) {
  const { folderId, itemType, recursive, filterOwners, filterEditors, filterCommenters, filterViewers, emails, removePermissions } = options;

  let currentFolderId = pageToken ? folderId : (folderStack.pop() || folderId);
  const query = `'${currentFolderId}' in parents and trashed = false`;
  const fields = 'nextPageToken, files(id, name, mimeType, owners, permissions, webViewLink, parents)';

  const response = Drive.Files.list({
    q: query,
    fields: fields,
    pageToken: pageToken,
    pageSize: 1000  // Adjust as needed
  });

  const items = response.files.filter(file => {
    const isFolder = file.mimeType === 'application/vnd.google-apps.folder';
    if (recursive && isFolder) {
      folderStack.push(file.id);
    }
    return (itemType === 'all') ||
           (itemType === 'files' && !isFolder) ||
           (itemType === 'folders' && isFolder);
  });

  const filterOptions = { owners: filterOwners, editors: filterEditors, commenters: filterCommenters, viewers: filterViewers };
  const filteredItems = items.filter(item => shouldIncludeItem(filterOptions, emails, item));

  if (filteredItems.length > 0) {
    const sheet = getOrCreateAuditSheet();
    appendItemsToSheet(sheet, filteredItems);

    if (removePermissions && emails.length > 0) {
      const removedCount = removePermissionsBatch(filteredItems, emails);
      Logger.log(`Removed ${removedCount} permissions in this batch.`);
    }
  }

  updateProgress(response.nextPageToken, folderStack);

  if (!response.nextPageToken && folderStack.length > 0) {
    return { nextPageToken: null, folderStack: folderStack };
  }

  return { nextPageToken: response.nextPageToken, folderStack: folderStack };
}


function shouldIncludeItem(filterOptions, emails, item) {
  if (emails.length === 0) return true;

  const permissions = item.permissions || [];
  const owner = item.owners && item.owners.length > 0 ? item.owners[0].emailAddress : '';

  return (filterOptions.owners && emails.includes(owner)) ||
         (filterOptions.editors && permissions.some(p => p.role === 'writer' && emails.includes(p.emailAddress))) ||
         (filterOptions.commenters && permissions.some(p => p.role === 'commenter' && emails.includes(p.emailAddress))) ||
         (filterOptions.viewers && permissions.some(p => p.role === 'reader' && emails.includes(p.emailAddress)));
}

function removePermissionsBatch(items, emailsToRemove) {
  const batchSize = 50; // Adjust this number based on your needs and API quotas
  let removedCount = 0;

  for (let i = 0; i < items.length; i += batchSize) {
    const batch = items.slice(i, i + batchSize);

    batch.forEach(item => {
      emailsToRemove.forEach(email => {
        const permission = item.permissions.find(p => p.emailAddress === email);
        if (permission) {
          try {
            Drive.Permissions.remove(item.id, permission.id);
            removedCount++;
          } catch (error) {
            console.error(`Error removing permission for ${email} on file ${item.id}: ${error}`);
          }
        }
      });
    });

    // Add a small delay between batches to avoid hitting API limits
    Utilities.sleep(1000);
  }

  return removedCount;
}

function getOrCreateAuditSheet() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  let sheet = ss.getSheetByName('File Audit Results');
  if (!sheet) {
    sheet = ss.insertSheet('File Audit Results');
    sheet.appendRow(['File/Folder Name', 'Type', 'Owner', 'Sharing Access', 'Editors', 'Commenters', 'Viewers', 'URL']);
  }
  return sheet;
}

function appendItemsToSheet(sheet, items) {
  const rows = items.map(item => [
    item.name,
    item.mimeType === 'application/vnd.google-apps.folder' ? 'Folder' : 'File',
    item.owners[0].emailAddress,
    item.permissions.length > 1 ? 'Shared' : 'Not Shared',
    item.permissions.filter(p => p.role === 'writer').map(p => p.emailAddress).join(', '),
    item.permissions.filter(p => p.role === 'commenter').map(p => p.emailAddress).join(', '),
    item.permissions.filter(p => p.role === 'reader').map(p => p.emailAddress).join(', '),
    item.webViewLink
  ]);

  sheet.getRange(sheet.getLastRow() + 1, 1, rows.length, rows[0].length).setValues(rows);
}

function updateProgress(nextPageToken, folderStack) {
  const props = PropertiesService.getScriptProperties();
  const currentProgress = Number(props.getProperty('auditProgress') || 0);
  const newProgress = nextPageToken || folderStack.length > 0 ? Math.min(currentProgress + 5, 95) : 100;
  props.setProperty('auditProgress', newProgress.toString());
}

function getAuditProgress() {
  const props = PropertiesService.getScriptProperties();
  return Number(props.getProperty('auditProgress') || 0);
}