// This script file is licensed under a Creative Commons
// Attribution 4.0 International License (cc by 4.0):
// http://creativecommons.org/licenses/by/4.0/
// You may adapt and/or share this script file for any purpose,
// provided you give credit to http://bridgecomposer.com

//  This script scans a folder (and optionally its subfolders) for PBN files,
//  and applies a specified BridgeComposer layout to all of them.
//
//  For details about a BridgeComposer layout, use BridgeComposer "Help>Help Topics",
//  Index tab, and double-click the "Format Layout submenu" item. Scroll down to the
//  "Layout Settings" subtopic.
//
//  To use from the BridgeComposer Script menu, first open any document with
//  the desired layout. Then start the script from the Script menu.
//
//  To use from a command line or by double clicking, start the script and you
//  will be prompted to open a document. Select any document with the
//  desired layout.
//
//  Either way, you will then be prompted for the folder to scan. Select the
//  folder containing the PBN files you wish to have the layout applied to.
//  You will then be asked whether or not to process subfolders of this folder.
//  Your choices will be confirmed, and then processing will begin.
//
//  First, a backup copy of the folder to be processed is made. The backup
//  will have the same path and name as the original, but with " - Copy" appended
//  to the name. (In case of duplication, " - Copy (n)" will be appended, where
//  "n" is set to 2, 3, 4, ..., as needed to be unique.)
//
//  All PBN files in the original folder (and its subfolders, if that option is selected)
//  will have the layout of the starting document applied.
//  Exception: Any PBN file that has the "read-only" attribute will not be changed.

//  $Id: LayoutApply.wsf 110 2022-09-03 05:16:49Z Ray $

<job>
<script language="JScript" src="BCConst.js" />
<script language="JScript" src="BCDeal.js" />
<script language="JScript">

var FILE_ATTRIBUTE_READONLY = 1;

function Exit(rc)
{
  var disp = (rc) ? "canceled" : "complete";
  bc.progress(BCP_FINISH, 'LayoutApply ' + disp + ': ' + nFind + ' documents updated\n' + strFind);
  WScript.Quit(rc);
}

function CreateBackup(strFolder)
{
  for (var i = 1;; ++i) {
    var strDest = strFolder + ' - Copy';
    if (i > 1)
      strDest += ' (' + i + ')';
    
    if (!fso.FolderExists(strDest))
      break;
  }
  
  var cmd = 'xcopy "' + strFolder + '" "' + strDest + '" /i';   // dest is a directory
  if (bSubfolders)
    cmd += ' /s /e';  // copy subfolders including empty
  
  cmd += ' /k /b';  // keep read-only attribute, keep symbolic link
  var rc = wsh.Run(cmd, 0, true);
  if (rc !== 0)
  {
    bc.progress(BCP_FINISH, 'LayoutApply: CreateBackup: xcopy failed\n'
      + cmd + '\n'
      + 'Exit code ' + rc);
    WScript.Quit(rc);
  }
}

function ScanFolder(fldr)
{
  //if (!bc.confirm('Scanning folder ' + fldr.Self.Path, MB_ICONINFORMATION)) WScript.Quit();
  var items = fldr.Items();
  for (var i = 0; i < items.Count; ++i) {
    var item = items.Item(i);
    if (item.IsFolder) {
      if (bSubfolders) {
        ScanFolder(item.GetFolder);
      }
    } else {
      ScanFile(item);
    }
  }
}

function ScanFile(item)
{
  var fname = item.Name;
  //WScript.Echo('Scanning file', strPath, fname);
  if (!bc.progress(BCP_UPDATE, 'Scanning ' + item.Path + '\n' + nFind + ' found')) Exit(1);
  var ixx = fname.lastIndexOf('.');
  if (ixx < 0)
    return;
    
  var ftype = fname.slice(ixx + 1);
  ftype = ftype.toLowerCase();
  if (ftype !== "pbn")
    return;
    
  var fpath = item.Path;
  
  //  Check for read-only
  
  var fitem = fso.GetFile(fpath);
  var attr = fitem.Attributes;
  if (attr & FILE_ATTRIBUTE_READONLY)
    return;
  
  try {
    bc.Open(fpath);
  } catch(ex) {
    return;
  }
  
  bc.LoadLayout(pathLayout);
  bc.Save();
  ++nFind;
}

//  Initialize global variables

var bc = GetBC('5.96');
if (WScript.Arguments.length > 0)
  bc.Open(WScript.Arguments.Item(0));
else
  if (!bc.Open())
    WScript.Quit();



var pathLayout = bc.CallerPathname;
if (!pathLayout)
  pathLayout = bc.pathname;

var sh = WScript.CreateObject('Shell.Application');
var wsh = WScript.CreateObject('WScript.Shell');
var fso = WScript.CreateObject('Scripting.FileSystemObject');
var bSubfolders = false;
var nFind = 0;
var strFind = '';

//  Main program

(function()
{
  var strFolder = bc.BrowseForFolder('LayoutApply: Folder to scan');
  if (!strFolder) WScript.Quit();
  var str = 'Folder: ' + strFolder + '\n\nScan subfolders?';
  bSubfolders = bc.confirm(str, MB_YESNO | MB_DEFBUTTON2 | MB_ICONINFORMATION);
  var str = 'Confirm:'
    + '\nApply layout from: ' + pathLayout
    + '\nTo all PBN in folder: ' + strFolder
    + '\nAnd subfolders: ' + ((bSubfolders) ? 'Yes' : 'No');
  var bConfirm = bc.confirm(str, MB_ICONINFORMATION);
  if (!bConfirm)
    WScript.Quit();
  
  var strTitle = pathLayout;
  var ix = strTitle.lastIndexOf('\\');
  if (ix > 0)
    strTitle = strTitle.substr(ix + 1);
  
  bc.progress(BCP_TITLE, strTitle + ' - LayoutApply');
  CreateBackup(strFolder);
  var objFolder = sh.NameSpace(strFolder);  // convert string path into Folder object
  ScanFolder(objFolder);
  Exit(0);
})();
</script>
</job>