04_drive.gs

/**
 * Googleドライブのフォルダから指定のファイル名を含むファイルを2次元配列で取得
 * 'ファイル名', 'ファイルID', 'URL', '最終更新日'を取得できる
 * 
 * @param  {string} folderUrl - GoogleドライブのフォルダのURL
 * @param  {string} query - 検索したいファイル名、省略可
 * @return {Array.<Array.<string>>}
 * 
 */
function getFilesValues(folderUrl, query) {
  
  console.info('getFilesValues()を実行中');
  console.info('04_driveに記載');

  const files   = getDriveFiles(folderUrl);
  let newValues = [['ファイル名', 'ファイルID', 'URL', '最終更新日']];

  while (files.hasNext()) {
    const file     = files.next();
    const fileName = file.getName();

    // 検索クエリが指定されていて、ファイル名にクエリが含まれていない場合はスキップ
    if (query && !fileName.includes(query)) continue;

    const info = {
      fileName:    fileName,
      fileId:      file.getId(),
      fileUrl:     `https://drive.google.com/file/d/${file.getId()}/view`,
      lastUpdated: formatDate(file.getLastUpdated(), 'yyyy/MM/dd')
    }

    console.log(info);
    newValues.push(Object.values(info));
  }

  console.log(newValues);
  return newValues;
}



/**
 * GoogleドライブのURLからフォルダIDを抽出する
 * 
 * @param  {string} folderUrl - GoogleドライブのフォルダのURL
 * @param  {boolean} hasLog - 省略可。定義されている場合のみ、実行中の関数名を表記する
 * @return {string}
 * 
 */
function getFolderId(folderUrl, hasLog){

  if(hasLog){
    console.info('getFolderId()を実行中');
    console.info('04_driveに記載');
  }

  const reg      = /.*\//;
  const lists    = [[reg, ''], [/.hl=.*/, '']];
  const folderId = folderUrl.match(reg) !== null ? lists.reduce((accumulator, current) => accumulator.replace(...current), folderUrl) : false

  console.log(`folderName: ${DriveApp.getFolderById(folderId).getName()}`);
  console.log(`folderUrl:  ${folderUrl}`);
  console.log(`folderId:   ${folderId}`);

  return folderId
}



/**
 * Googleドライブのフォルダ内のファイルのオーナー権限を一括で指定の相手に譲渡する
 * FIXME: 個人からビジネスドメインへの権限移譲は失敗することがある
 * FIXME: 個人アカウントには、ファイルのオーナー権限を譲渡という概念がないので失敗する
 * 
 * @param  {string} folderUrl - GoogleドライブのフォルダのURL
 * @param  {string} accountId - ファイルを譲渡したいアカウントID
 * @return {Array.<Array.<string>>}
 * 
 */
function transferOwnership(folderUrl, accountId){

  console.info('transferOwnership()を実行中');
  console.info('04_driveに記載');

  const files = getDriveFiles(folderUrl);

  while (files.hasNext()) {
    const file = files.next();
    console.log(`ファイル名：${file.getName()}`);

    try{
      file.setOwner(accountId).setDescription('一括で、オーナー権限を移すテスト');

    }catch{
      console.warn(`ファイル譲渡に失敗しました。`);
      console.log(`個人からビジネスドメインへの権限移譲は制限されている可能性あります。`);
      console.log(`もしくは、ファイルへのアクセスが制限されている可能性があります`);

    }
  }
}



/**
 * Googleドライブの特定フォルダ内のファイルを取得する
 * 
 * @param  {string} folderUrl - GoogleドライブのフォルダのURL
 * @param  {boolean} hasLog - 省略可　引数が定義されている場合のみ実行中の関数名を表示する
 * @return {Object.<Object.<string>>}
 * 
 */
function getDriveFiles(folderUrl, hasLog){

  if(hasLog){
    console.info('getDriveFiles()を実行中');
    console.info('04_driveに記載');
  }
  
  const folderId = getFolderId(folderUrl);
  const folder   = DriveApp.getFolderById(folderId);
  const files    = folder.getFiles();

  console.log(`取得対象のフォルダ：　${folder.getName()}`);

  return files
}

/*
共有範囲
DriveApp.getFileById('File_ID').getSharingAccess();

ANYONE: ウェブ上で一般公開
ANYONE_WITH_LINK: リンクを知っている全員
DOMAIN: DOMAIN内の全員
DOMAIN_WITH_LINK: DOMAIN内でリンクを知っている全員
PRIVATE: 特定のユーザ

共有範囲の権限
DriveApp.getFileById('File_ID').getSharingPermission();
VIEW: 閲覧者
EDIT: 編集者
COMMENT: コメント可
OWNER: オーナー
ORGANIZER: オーガナイザー
NONE: なし
*/

/**
 * 指定したユーザーにフォルダの閲覧権限や編集権限を一括で付与する
 * FIXME: 一度編集権限を付与してしまうとアクセス権を剥奪しないと閲覧オンリーなどに切り替えることが出来ない
 * FIXME: フォルダの編集権限を付与する関数で、folderUrlにスプレッドシートのURLを指定するとエラーが起きる
 * 
 * @param  {string} folderUrl - GoogleドライブのフォルダのURL
 * @param  {string} users - 権限を付与したいユーザーを格納した配列
 * @param  {string} role - 編集 or 閲覧
 * 
 */
function grantEditPermissionToFolder(folderUrl, users, role){

  console.info('grantEditPermissionToFolder()を実行中');
  console.info('04_driveに記載');

  const folderId = getFolderId(folderUrl);
  const folder   = DriveApp.getFolderById(folderId);
  const reg      = / gmail.* | icloud.* /;

  const permission = role === '編集' ? DriveApp.Permission.EDIT : DriveApp.Permission.VIEW;

  for(const user of users){

    if(user.match(reg) !== null){
      // 個人のフリーアドレス宛に権限を付与する
      console.log(`${user} に ${folder.getName()}　の　${role}権限を付与しました`);
      folder.addEditor(user).setSharing(DriveApp.Access.PRIVATE, permission);

    }else{
      // ドメイン内のユーザーに引数に応じた権限を付与する
      console.log(`${user} に ${folder.getName()}　の　${role}権限を付与しました`);
      folder.addEditor(user).setSharing(DriveApp.Access.ANYONE_WITH_LINK, permission);

    }
  }
  console.log(`全員に権限の付与が完了しました`);
}



/**
 * 1次元配列の内容を元にフォルダを作成する
 * 
 * @param  {string} folderUrl - GoogleドライブのフォルダのURL
 * @param  {Array.<string>} newFolderNameList - 1次元配列　この配列に格納された値がフォルダ名となる
 * @return {Array.<string>} innerFolderNameList - 1次元配列　さらに内側にフォルダを作成する場合に指定する
 * 
 */
function createFolders(folderUrl, newFolderNameList, innerFolderNameList) {

  console.info('createFolders()を実行中');
  console.info('04_driveに記載');

  const folderId = getFolderId(folderUrl);
  const folder   = DriveApp.getFolderById(folderId);

  console.log(`対象フォルダー名：${folder.getName()}`);
  console.log(`${newFolderNameList.length}個のフォルダーを新規作成します。`);

  for(const newFolderName of newFolderNameList){
    const newFolder = folder.createFolder(newFolderName);
    console.log(`${newFolderName}というフォルダが新規作成されました`);

    if(innerFolderNameList){
      for(const innerFolderName of innerFolderNameList){
        newFolder.createFolder(innerFolderName);
        console.log(`${newFolderName}の中に、${innerFolderName}というフォルダが新規作成されました`);
      }
    }
  }
  console.log(`全てのフォルダの作成が終了しました。作成結果が反映されるまで少し時間が掛かる場合があります`);

}



/**
 * スプレッドシートから印刷範囲を指定してPDFを作成、指定したフォルダに保存
 * 
 * @param  {string} sheetUrl - スプレッドシートのURL
 * @param  {string} stringRange - 'A2:D30' などPDFの生成範囲
 * @param  {string} folderUrl - フォルダのURL
 * @param  {boolean} isGridLines - グリッドラインの表示有無　true or falseで指定
 * 
 */
function convertSheetToPdf(sheetUrl, stringRange, folderUrl, isGridLines){

  console.info('convertSheetToPdf()を実行中');
  console.info('04_driveに記載');

  const sheet    = getSheetByUrl(sheetUrl);
  const today    = formatDate(new Date(), 'yyyy_MMdd_HH:mm');
  const fileName = `${sheet.getName()}_${today}`;
  console.log(`生成されたPDFファイル：　${fileName}`);

  // FetchするURLを生成
  const targetUrl = generateUrlWithSheetOptions_(sheet, stringRange, isGridLines);
  createPdfFile_(targetUrl, folderUrl, fileName)
}



/**
 * スプレッドシートから指定したエクスポートオプションを含むURLを生成します。
 * 
 * @param  {SpreadsheetApp.Sheet} sheet - シートオブジェクト
 * @param  {string} stringRange - 'A2:D30' などPDFの生成範囲
 * @param  {boolean} isGridLines - グリッドラインの表示有無　true or falseで指定
 * @return {string}
 * 
 */
function generateUrlWithSheetOptions_(sheet, stringRange, isGridLines){

  console.info('generateUrlWithSheetOptions_()を実行中');
  console.info('04_driveに記載');

  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  const info  = {
    spreadsheetId: spreadsheet.getId(),
    sheetId: sheet.getSheetId(),
    printArea: stringRange.replace(':', '%3A')
  }

  console.log(info);

  // 印刷情報、サイズや紙の向きや範囲などの情報を付与する
  const exportOptions = {
    format: 'pdf',
    size: 'A4',
    portrait: 'true',
    fitw: 'true',
    sheetnames: 'false',
    printtitle: 'false',
    pagenumbers: 'false',
    gridlines: isGridLines,
    fzr: 'false',
    range: info.printArea,
    gid: info.sheetId
  };

  console.log(exportOptions);

  const queryString = Object.entries(exportOptions)
    .map(([key, value]) => `${key}=${value}`)
    .join('&');

  const targetUrl = `https://docs.google.com/spreadsheets/d/${info.spreadsheetId}/export?${queryString}`;
  console.log(targetUrl);

  return targetUrl
}



/**
 * スプレッドシート、ドキュメント、スライドからPDFファイルを作成
 * 
 * @param  {string} targetUrl - FetchするURL
 * @param  {string} folderUrl - Google DriveのフォルダURL
 * @param  {boolean} fileName - PDFのファイル名
 * @return {Object.<string>}
 * 
 */
function createPdfFile_(targetUrl, folderUrl, fileName){

  console.info('createPdfFile_()を実行中');
  console.info('04_driveに記載');

  const token    = ScriptApp.getOAuthToken();
  const response = UrlFetchApp.fetch(targetUrl, {
    headers: {
      'Authorization': 'Bearer ' + token
    }
  });

  const blob     = response.getBlob().setName(fileName + '.pdf');
  const folderId = getFolderId(folderUrl);
  DriveApp.getFolderById(folderId).createFile(blob);
}



/**
 * Google Driveのフォルダ内のファイル名に連番付与とリネームが出来るスクリプト
 * 
 * @param {string} folderUrl - フォルダのURL
 * @param {Array.<Array.<string>>} values - [['置換対象', '置換後']]
 * @param {number} maxLength - 連番の最終番号　(例)100
 * 
 */
function renameAllFiles(folderUrl, values, maxLength){

  console.info('renameAllFiles()を実行中');
  console.info('04_driveに記載');

  let count = 0;
  let lists = [[/\s/g, '']];

  // 引数に指定された置換対象を追加する
  lists = values ? lists.concat(values) : lists;
  console.log(`結合後`);
  console.log(lists);

  let newValues = [];
  const files   = getDriveFiles(folderUrl);

  while (files.hasNext()) {
    const file        = files.next();
    const original    = file.getName();
    const newFileName = lists.reduce((accumulator, list) => accumulator.replace(...list), original);
    count += 1;

    console.log(`変更前: ${count}. ${original}`);
    console.log(`変更後: ${count}. ${newFileName}`);
    
    newValues.push([newFileName, file.getId()]);

  }

  console.log(`${count}件`);
  console.log(newValues);

  // ファイル名を一括変更する前に確認画面を表示する
  renameFilesWithConfirmation_(newValues, maxLength);

}



/**
 * 実行前にアラートを表示する
 * 
 * @param {Array.<Array.<string>>} values - [['ファイル名', 'ファイルID']]
 * @param {number} maxLength - 連番の最終番号　(例)100 
 * 
 */
function renameFilesWithConfirmation_(values, maxLength){

  console.info('showAlertBeforeExecution_()を実行中');
  console.info('04_driveに記載');

  const string = values.map(record => record[0]).join('\n');
  console.log(string);

  const ui = SpreadsheetApp.getUi();
  const response = ui.alert(`
    ファイル名を下記のように変更してもよろしいですか？\n\n
    ${string}`, ui.ButtonSet.YES_NO
  );

  let count = 0;
  let serialNumbers = [];

  // 指定があった場合のみ、連番の配列を作成する
  maxLength ? serialNumbers = Array.from({ length: maxLength}, (_, i) => ('00' + (i + 1)).slice(-3)) : false
  
  switch (response){
    case ui.Button.YES:
      console.log('“はい” のボタンが押されました。');

      for(const [fileName, fileId] of values){
        console.log(`fileName: ${fileName}, fileId: ${fileId}`);
        const extension    = getExtensionFromFileName_(fileName);
        const baseFileName = fileName.replace(extension, '');
        
        // 連番作成の指定があれば、ファイル名の末尾に連番を入れる
        maxLength ? DriveApp.getFileById(fileId).setName(`${baseFileName}_${serialNumbers[count]}${extension}`) : 
        DriveApp.getFileById(fileId).setName(fileName)

        count += 1;
      }
      
      ui.alert('ファイル名の変更が完了しました。');
      break;

    case ui.Button.NO:
      console.log('“いいえ” のボタンが押されました。');
      ui.alert('処理が中断されました。');
      break;

    default:
      console.log('処理が中断されました。');
      return
  }
}



/**
 * リンク付きのファイル一覧をHTMLとして表示する
 * 
 * @param  {string} folderUrl - フォルダのURL
 * @return {string} string - ファイル一覧のHTMLタグ
 * 
 */
function getFileNameWithUrl(folderUrl){

  console.info('getFileWithUrl()を実行中');
  console.info('04_driveに記載');

  const files = getDriveFiles(folderUrl);
  let html    = '';

  while (files.hasNext()) {
    const file     = files.next();
    const fileName = file.getName();
    const fileUrl  = `https://drive.google.com/file/d/${file.getId()}/view`;
    console.log(fileUrl);
    
    html += `<p><a href="${fileUrl}">${fileName}</a></p>`;

  }
  console.log(html);
  showHtmlSentence(html, 'ファイル一覧を表示します');
}



/**
* フォルダから画像ファイルのみを取得し、ファイル名でsortし2次元配列で返す
* [['ファイル名_01.jpg', 'ファイルID'], ['ファイル名_02.jpg', 'ファイルID']]
* 22. getDriveFiles()と挙動が近いが、こちらは画像ファイルのみを配列に加える
* 
* @param  {string} folderUrl - Google DriveのフォルダのURL
* @return {Array.<Array.<string>>}
* 
*/
function getImageFiles_(folderUrl) {

  console.info('getImageFiles_()を実行中');
  console.info('04_driveに記載');

  const files  = getDriveFiles(folderUrl);
  const values = [];

  //jpg、gif、pngを取得してシートの最終行に挿入する
  while(files.hasNext()){
    const file = files.next();
    if(file.getMimeType().match(/^image\/(?:jpeg|gif|png)$/i)) {
      values.push([file.getName(), file.getId()]);
    }
  }

  //ファイル名を連番順にSORTする
  values.sort((previous, current) => previous[0] < current[0] ? -1:1);
  console.log(values);
  console.log(`${values.length} 件`);

  return values

}



/**
 * ファイル名から拡張子を取得する
 * 
 * @param  {string} fileName - ファイル名
 * @return {string} 
 * 
 */
function getExtensionFromFileName_(fileName){

  console.info('getExtensionFromFileName_()を実行中');
  console.info('04_driveに記載');

  const match = fileName.match(/.jpg|.png|.pdf/i);
  console.log(`matchの結果:${match}`);

  return match ? match[0].toLowerCase() : null;
}



/**
 * ドキュメントかシートのURLからファイルIDを返す
 * 
 * @param  {string} fileUrl - ドキュメントかシートのURL
 * @return {string} ファイルIDを返す
 * 
 */
/**
 * ドキュメントかシートのURLからファイルIDを返す
 * 
 * @param  {string} fileUrl - ドキュメントかシートのURL
 * @return {string} ファイルIDを返す
 * 
 */
function getFileId(fileUrl) {
  
  console.info('getFileId()を実行中');
  console.info('04_driveに記載');

  // スプレッドシートURLとドキュメントURLの両方をチェック
  const match = fileUrl.match(/\/(spreadsheets|document)\/d\/([\w-]+)\//);
  if (match && match[2]) {
    const fileId = match[2];
    
    console.log(`URL: ${fileUrl}`);
    console.log(`ファイルID: ${fileId}`);
    console.log(`ファイル名: ${DriveApp.getFileById(fileId).getName()}`);

    return fileId;
  }

  // ファイルIDが見つからない場合は null を返す
  return null;
}