workbench/c/Filenote.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Filenote CLI command
   6     Lang: english
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME
  12
  13         Filenote
  14
  15     SYNOPSIS
  16
  17         FILE/A,COMMENT,ALL/S,QUIET/S
  18
  19     LOCATION
  20
  21         Workbench:c
  22
  23     FUNCTION
  24
  25         Add a comment to a file or directory.
  26
  27         Filenote allows a recursive scan of all directories adding comments
  28         to each file/directory it finds that matches the file pattern
  29         specified.
  30
  31     INPUTS
  32
  33         FILE    - Always has to be specified. Can be either a filename with
  34                   a full path or a file pattern that is to be matched.
  35
  36         COMMENT - The ASCII string that is to be added as a comment to the
  37                   file(s)/dir(s) specified.
  38
  39                   To provide a comment that has embedded quotation marks,
  40                   precede each quote with an asterisk.
  41
  42                     i.e. Filenote FILE=RAM:test.txt COMMENT=*"hello*"
  43
  44         ALL     - Boolean switch. If specified, Filenote scans the directories
  45                   that match the pattern specified, recursively.
  46
  47         QUIET   - Boolean switch. If specified, no diagnostic text will be
  48                   displayed to stdout.
  49
  50     RESULT
  51
  52         Standard DOS return codes.
  53
  54     NOTES
  55
  56         Output from AROS' Filenote is more neat and structured than the
  57         standard Filenote command.
  58
  59         Does not yet support multi-assigns.
  60
  61     EXAMPLE
  62
  63         Filenote ram: hello all
  64
  65             Recurses through each directory in RAM: adding "hello" as a
  66             filenote to each file/directory.
  67
  68     BUGS
  69
  70     SEE ALSO
  71
  72         dos.library/SetComment()
  73
  74     INTERNALS
  75
  76     HISTORY
  77
  78         27-Jul-1997     laguest     Initial inclusion into the AROS tree
  79
  80 ******************************************************************************/
  81
  82 #include <proto/arossupport.h>
  83 #include <proto/dos.h>
  84 #include <proto/exec.h>
  85
  86 #include <dos/dos.h>
  87 #include <dos/dosasl.h>
  88 #include <dos/dosextens.h>
  89 #include <dos/rdargs.h>
  90 #include <exec/memory.h>
  91 #include <utility/utility.h>
  92
  93 #include <ctype.h>
  94
  95 #include <aros/rt.h>
  96
  97 #define ERROR_HEADER "Filenote"
  98
  99 #define ARG_TEMPLATE    "FILE/A,COMMENT,ALL/S,QUIET/S"
 100 #define ARG_FILE        0
 101 #define ARG_COMMENT     1
 102 #define ARG_ALL         2
 103 #define ARG_QUIET       3
 104 #define TOTAL_ARGS      4
 105
 106 /* To define whether a command line switch was set or not.
 107  */
 108 #define NOT_SET         0
 109
 110 #define MAX_PATH_LEN    512
 111
 112 static const char version[] = "$VER: Filenote 41.1 (29.08.1998)\n";
 113
 114 int Do_Filenote(struct AnchorPath *, STRPTR, STRPTR, LONG, LONG);
 115
 116 int __nocommandline;
 117
 118 int main(void)
 119 {
 120     struct RDArgs     * rda;
 121     struct AnchorPath * apath;
 122     IPTR                args[TOTAL_ARGS] = { NULL, NULL, NULL, NULL};
 123     int                 Return_Value;
 124
 125     RT_Init();
 126
 127     Return_Value = RETURN_OK;
 128
 129     apath = AllocVec(sizeof(struct AnchorPath) + MAX_PATH_LEN,
 130                      MEMF_ANY | MEMF_CLEAR);
 131     if (apath)
 132     {
 133         /* Make sure DOS knows the buffer size.
 134          */
 135         apath->ap_Flags = APF_DOWILD | APF_FollowHLinks;
 136         apath->ap_Strlen = MAX_PATH_LEN;
 137         apath->ap_BreakBits = 0;
 138         apath->ap_FoundBreak = 0;
 139
 140         rda = ReadArgs(ARG_TEMPLATE, args, NULL);
 141         if (rda)
 142         {
 143             Return_Value = Do_Filenote(apath,
 144                                        (STRPTR)args[ARG_FILE],
 145                                        (STRPTR)args[ARG_COMMENT],
 146                                        (LONG)args[ARG_ALL],
 147                                        (LONG)args[ARG_QUIET]
 148             );
 149             FreeArgs(rda);
 150         }
 151         else
 152         {
 153             PrintFault(IoErr(), ERROR_HEADER);
 154
 155             Return_Value = RETURN_ERROR;
 156         }
 157     }
 158     else
 159     {
 160         Return_Value = RETURN_FAIL;
 161     }
 162
 163     FreeVec(apath);
 164
 165     RT_Exit();
 166
 167     return (Return_Value);
 168
 169 } /* main */
 170
 171
 172 /* Defines whether MatchFirst(), etc has matched a file.
 173  */
 174 #define MATCHED_FILE    0
 175
 176 void PrintFileName(struct AnchorPath *, LONG);
 177 int SafeSetFileComment(struct AnchorPath *, char *);
 178
 179 int Do_Filenote(struct AnchorPath *a,
 180                 STRPTR File,
 181                 STRPTR Comment,
 182                 LONG All,
 183                 LONG Quiet)
 184 {
 185     LONG  Result,
 186           TabValue;
 187     int   Return_Value;
 188
 189     Return_Value = RETURN_OK;
 190     TabValue     = 0L;
 191
 192     /* Looks to see if the user has given a volume name as a pattern
 193      * without the all switch set. If so, we fail.
 194      */
 195
 196     if
 197     (
 198         IsDosEntryA((char *)File, LDF_VOLUMES | LDF_DEVICES) == TRUE
 199     &&
 200         All == NOT_SET
 201     )
 202     {
 203         PrintFault(ERROR_OBJECT_WRONG_TYPE, ERROR_HEADER);
 204         Return_Value = RETURN_FAIL;
 205     }
 206     else
 207     {
 208         if (Return_Value != RETURN_FAIL)
 209         {
 210             Result = MatchFirst(File, a);
 211
 212             if (Result == MATCHED_FILE)
 213             {
 214                 do
 215                 {
 216                     if (All == NOT_SET)
 217                     {
 218                         Return_Value = SafeSetFileComment(a, Comment);
 219
 220                         if (Quiet == NOT_SET)
 221                         {
 222                             PrintFileName(a, TabValue);
 223                         }
 224                     }
 225                     else
 226                     {
 227                         /* Allow a recursive scan.
 228                          */
 229
 230                         if (a->ap_Info.fib_DirEntryType > 0)
 231                         {
 232                             /* Enter directory.
 233                              */
 234                             if (!(a->ap_Flags & APF_DIDDIR))
 235                             {
 236                                 a->ap_Flags |= APF_DODIR;
 237
 238                                 Return_Value = SafeSetFileComment(a, Comment);
 239
 240                                 if (Quiet == NOT_SET)
 241                                 {
 242                                     PrintFileName(a, TabValue);
 243                                 }
 244                                 TabValue++;
 245                             }
 246                             else
 247                             {
 248                                 /* Leave directory.
 249                                  */
 250                                 a->ap_Flags &= ~APF_DIDDIR;
 251                                 TabValue--;
 252                             }
 253                         }
 254                         else
 255                         {
 256                             Return_Value = SafeSetFileComment(a, Comment);
 257
 258                             if (Quiet == NOT_SET)
 259                             {
 260                                 PrintFileName(a, TabValue);
 261                             }
 262                         }
 263                     }
 264                 }
 265                 while
 266                 (
 267                     ((Result = MatchNext(a)) == MATCHED_FILE)
 268                 &&
 269                     Return_Value != RETURN_FAIL
 270                 );
 271             }
 272             else
 273             {
 274                 PrintFault(IoErr(), ERROR_HEADER);
 275                 Return_Value = RETURN_FAIL;
 276             }
 277
 278             MatchEnd(a);
 279         }
 280     }
 281
 282     return (Return_Value);
 283
 284 } /* Do_Filenote */
 285
 286
 287 void PrintFileName(struct AnchorPath *a, LONG t)
 288 {
 289     int i;
 290     IPTR args[2];
 291
 292     args[0] = (IPTR)FilePart(&a->ap_Buf[0]);
 293     args[1] = (IPTR)NULL;
 294
 295     VPrintf("   ", NULL);
 296
 297     for (i = 0; i != t; i++)
 298     {
 299         VPrintf("  ", NULL);
 300     }
 301
 302     VPrintf("%s", args);
 303
 304     if (a->ap_Info.fib_DirEntryType > 0)
 305     {
 306         VPrintf(" (dir)", NULL);
 307     }
 308
 309     VPrintf("...Done\n", NULL);
 310
 311 } /* PrintFileName */
 312
 313
 314 int SafeSetFileComment(struct AnchorPath *a, char *c)
 315 {
 316     int Return_Value;
 317
 318     Return_Value = RETURN_OK;
 319
 320     if (!SetComment(a->ap_Buf, c))
 321     {
 322         Return_Value = RETURN_WARN;
 323     }
 324
 325     return(Return_Value);
 326
 327 } /* SafeSetFileComment */