logger.m

function logMsg = logger(varargin)
  %
  %   Returns logger message
  %
  % USAGE::
  %
  %   logger(logLevel, msg, 'options', opt, 'filename', filename, 'id', id)
  %
  % :param logLevel: Any of ``{'ERROR', 'WARNING', 'INFO', 'DEBUG'}``
  % :type  logLevel: char
  %
  % :param msg:
  % :type  msg: char
  %

  % (C) Copyright 2022 bidspm developers

  ALLOWED_LOG_LEVELS = {'ERROR', 'WARNING', 'INFO', 'DEBUG'};

  default_opt = struct('verbosity', 2);

  args = inputParser;

  addRequired(args, 'logLevel', @ischar);
  addRequired(args, 'msg', @ischar);
  addParameter(args, 'options', default_opt, @isstruct);
  addParameter(args, 'filename', '', @ischar);
  addParameter(args, 'id', '', @ischar);
  addParameter(args, 'color', 'blue', @ischar);

  parse(args, varargin{:});

  logLevel = args.Results.logLevel;
  msg = args.Results.msg;
  opt = args.Results.options;
  filename = args.Results.filename;
  id = args.Results.id;
  color = args.Results.color;

  [~, filename, ext] = fileparts(filename);

  if ~ismember(logLevel, ALLOWED_LOG_LEVELS)
    logger('ERROR', ...
           ['log levels must be one of:', ...
            bids.internal.create_unordered_list(ALLOWED_LOG_LEVELS)], ...
           'filename', mfilename(), ...
           'id', 'wrongLogLevel');
  end

  format = '\n[%s] bidspm - %s\t\t\t\t%s\n%s';

  logMsg = sprintf(format, ...
                   datestr(now, 'HH:MM:SS'), ...
                   logLevel, ...
                   [filename, ext], ...
                   msg);

  % print file that sent the message
  if ismember(logLevel, {'INFO', 'DEBUG'})
    if ~strcmp(id, '')
      logMsg = sprintf('%s\t\t\t%s', logMsg, id);
    end
  end

  logMsg = [logMsg, '\n'];

  if ismember(logLevel, {'ERROR'})
    tmpOpt = opt;
    tmpOpt.verbosity = 3;
    errorHandling(filename, id, logMsg, false);
  end

  switch opt.verbosity

    case 1
      if ismember(logLevel, {'WARNING'})
        errorHandling(filename, id, logMsg, true, true);
      end

    case 2
      if ismember(logLevel, {'WARNING'})
        errorHandling(filename, id, logMsg, true, true);
      end
      if ismember(logLevel, {'INFO'})
        printToScreen(logMsg, opt, 'format', color);
      end

    case 3
      if ismember(logLevel, {'WARNING'})
        errorHandling(filename, id, logMsg, true, true);
      end
      if ismember(logLevel, {'INFO', 'DEBUG'})
        printToScreen(logMsg, opt, 'format', color);
      end
  end

end