workbench/c/Filenote.c

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