workbench/c/Filenote.c

   1 /*
   2     Copyright © 1995-2008, 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         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 ******************************************************************************/
  78
  79 #include <proto/arossupport.h>
  80 #include <proto/dos.h>
  81 #include <proto/exec.h>
  82
  83 #include <dos/dos.h>
  84 #include <dos/dosasl.h>
  85 #include <dos/dosextens.h>
  86 #include <dos/rdargs.h>
  87 #include <exec/memory.h>
  88 #include <utility/utility.h>
  89
  90 #include <ctype.h>
  91
  92 #include <aros/rt.h>
  93
  94 #define ERROR_HEADER "Filenote"
  95
  96 #define ARG_TEMPLATE    "FILE/A,COMMENT,ALL/S,QUIET/S"
  97 #define ARG_FILE        0
  98 #define ARG_COMMENT     1
  99 #define ARG_ALL         2
 100 #define ARG_QUIET       3
 101 #define TOTAL_ARGS      4
 102
 103 /* To define whether a command line switch was set or not.
 104  */
 105 #define NOT_SET         0
 106
 107 #define MAX_PATH_LEN    512
 108
 109 const TEXT version[] = "$VER: Filenote 41.1 (29.8.1998)\n";
 110
 111 int Do_Filenote(struct AnchorPath *, STRPTR, STRPTR, LONG, LONG);
 112
 113 int __nocommandline;
 114
 115 int main(void)
 116 {
 117     struct RDArgs     * rda;
 118     struct AnchorPath * apath;
 119     IPTR                args[TOTAL_ARGS] = { NULL, (IPTR)"", NULL, NULL};
 120     int                 Return_Value;
 121
 122     RT_Init();
 123
 124     Return_Value = RETURN_OK;
 125
 126     apath = AllocVec(sizeof(struct AnchorPath) + MAX_PATH_LEN,
 127                      MEMF_ANY | MEMF_CLEAR);
 128     if (apath)
 129     {
 130         /* Make sure DOS knows the buffer size.
 131          */
 132         apath->ap_Flags = APF_DOWILD | APF_FollowHLinks;
 133         apath->ap_Strlen = MAX_PATH_LEN;
 134         apath->ap_BreakBits = 0;
 135         apath->ap_FoundBreak = 0;
 136
 137         rda = ReadArgs(ARG_TEMPLATE, args, NULL);
 138         if (rda)
 139         {
 140             Return_Value = Do_Filenote(apath,
 141                                        (STRPTR)args[ARG_FILE],
 142                                        (STRPTR)args[ARG_COMMENT],
 143                                        (LONG)args[ARG_ALL],
 144                                        (LONG)args[ARG_QUIET]
 145             );
 146             FreeArgs(rda);
 147         }
 148         else
 149         {
 150             PrintFault(IoErr(), ERROR_HEADER);
 151
 152             Return_Value = RETURN_ERROR;
 153         }
 154     }
 155     else
 156     {
 157         Return_Value = RETURN_FAIL;
 158     }
 159
 160     FreeVec(apath);
 161
 162     RT_Exit();
 163
 164     return (Return_Value);
 165
 166 } /* main */
 167
 168
 169 /* Defines whether MatchFirst(), etc has matched a file.
 170  */
 171 #define MATCHED_FILE    0
 172
 173 void PrintFileName(struct AnchorPath *, LONG);
 174 int SafeSetFileComment(struct AnchorPath *, char *);
 175
 176 int Do_Filenote(struct AnchorPath *a,
 177                 STRPTR File,
 178                 STRPTR Comment,
 179                 LONG All,
 180                 LONG Quiet)
 181 {
 182     LONG  Result,
 183           TabValue;
 184     int   Return_Value;
 185
 186     Return_Value = RETURN_OK;
 187     TabValue     = 0L;
 188
 189     /* Looks to see if the user has given a volume name as a pattern
 190      * without the all switch set. If so, we fail.
 191      */
 192
 193     if
 194     (
 195         IsDosEntryA((char *)File, LDF_VOLUMES | LDF_DEVICES) == TRUE
 196     &&
 197         All == NOT_SET
 198     )
 199     {
 200         PrintFault(ERROR_OBJECT_WRONG_TYPE, ERROR_HEADER);
 201         Return_Value = RETURN_FAIL;
 202     }
 203     else
 204     {
 205         if (Return_Value != RETURN_FAIL)
 206         {
 207             Result = MatchFirst(File, a);
 208
 209             if (Result == MATCHED_FILE)
 210             {
 211                 do
 212                 {
 213                     if (All == NOT_SET)
 214                     {
 215                         Return_Value = SafeSetFileComment(a, Comment);
 216
 217                         if (Quiet == NOT_SET)
 218                         {
 219                             PrintFileName(a, TabValue);
 220                         }
 221                     }
 222                     else
 223                     {
 224                         /* Allow a recursive scan.
 225                          */
 226
 227                         if (a->ap_Info.fib_DirEntryType > 0)
 228                         {
 229                             /* Enter directory.
 230                              */
 231                             if (!(a->ap_Flags & APF_DIDDIR))
 232                             {
 233                                 a->ap_Flags |= APF_DODIR;
 234
 235                                 Return_Value = SafeSetFileComment(a, Comment);
 236
 237                                 if (Quiet == NOT_SET)
 238                                 {
 239                                     PrintFileName(a, TabValue);
 240                                 }
 241                                 TabValue++;
 242                             }
 243                             else
 244                             {
 245                                 /* Leave directory.
 246                                  */
 247                                 a->ap_Flags &= ~APF_DIDDIR;
 248                                 TabValue--;
 249                             }
 250                         }
 251                         else
 252                         {
 253                             Return_Value = SafeSetFileComment(a, Comment);
 254
 255                             if (Quiet == NOT_SET)
 256                             {
 257                                 PrintFileName(a, TabValue);
 258                             }
 259                         }
 260                     }
 261                 }
 262                 while
 263                 (
 264                     ((Result = MatchNext(a)) == MATCHED_FILE)
 265                 &&
 266                     Return_Value != RETURN_FAIL
 267                 );
 268             }
 269             else
 270             {
 271                 PrintFault(IoErr(), ERROR_HEADER);
 272                 Return_Value = RETURN_FAIL;
 273             }
 274
 275             MatchEnd(a);
 276         }
 277     }
 278
 279     return (Return_Value);
 280
 281 } /* Do_Filenote */
 282
 283
 284 void PrintFileName(struct AnchorPath *a, LONG t)
 285 {
 286     int i;
 287     IPTR args[2];
 288
 289     args[0] = (IPTR)FilePart(&a->ap_Buf[0]);
 290     args[1] = (IPTR)NULL;
 291
 292     VPrintf("   ", NULL);
 293
 294     for (i = 0; i != t; i++)
 295     {
 296         VPrintf("  ", NULL);
 297     }
 298
 299     VPrintf("%s", args);
 300
 301     if (a->ap_Info.fib_DirEntryType > 0)
 302     {
 303         VPrintf(" (dir)", NULL);
 304     }
 305
 306     VPrintf("...Done\n", NULL);
 307
 308 } /* PrintFileName */
 309
 310
 311 int SafeSetFileComment(struct AnchorPath *a, char *c)
 312 {
 313     int Return_Value;
 314
 315     Return_Value = RETURN_OK;
 316
 317     if (!SetComment(a->ap_Buf, c))
 318     {
 319         Return_Value = RETURN_WARN;
 320     }
 321
 322     return(Return_Value);
 323
 324 } /* SafeSetFileComment */