]> git.p6c8.net - devedit.git/blobdiff - modules/Command.pm
- Cleaned the comments
[devedit.git] / modules / Command.pm
index ad660c3310ab462fd9cdec38c5af3f5587ad0db2..635d43d2906e6f13be3eaa391b00699854e2254f 100644 (file)
@@ -6,41 +6,64 @@ package Command;
 # Execute Dev-Editor's commands
 #
 # Author:        Patrick Canterino <patshaping@gmx.net>
-# Last modified: 09-23-2003
+# Last modified: 2003-12-02
 #
 
 use strict;
 
-use vars qw(@EXPORT
-            $script);
-
-use CGI qw(header
-           redirect);
+use vars qw(@EXPORT);
 
 use File::Access;
 use File::Copy;
+use File::Path;
 
 use HTML::Entities;
 use Output;
 use POSIX qw(strftime);
 use Tool;
 
-$script = $ENV{'SCRIPT_NAME'};
+my $script = $ENV{'SCRIPT_NAME'};
+
+my %dispatch = ('show'         => \&exec_show,
+                'beginedit'    => \&exec_beginedit,
+                'canceledit'   => \&exec_unlock,
+                'endedit'      => \&exec_endedit,
+                'mkdir'        => \&exec_mkdir,
+                'mkfile'       => \&exec_mkfile,
+                'workwithfile' => \&exec_workwithfile,
+                'workwithdir'  => \&exec_workwithdir,
+                'copy'         => \&exec_copy,
+                'rename'       => \&exec_rename,
+                'remove'       => \&exec_remove,
+                'rmdir'        => \&exec_rmdir,
+                'unlock'       => \&exec_unlock
+               );
 
 ### Export ###
 
 use base qw(Exporter);
 
-@EXPORT = qw(exec_show
-             exec_beginedit
-             exec_endedit
-             exec_mkfile
-             exec_mkdir
-             exec_workwithfile
-             exec_copy
-             exec_rename
-             exec_remove
-             exec_unlock);
+@EXPORT = qw(exec_command);
+
+# exec_command()
+#
+# Execute the specified command
+#
+# Params: 1. Command to execute
+#         2. Reference to user input hash
+#         3. Reference to config hash
+#
+# Return: Output of the command (Scalar Reference)
+
+sub exec_command($$$)
+{
+ my ($command,$data,$config) = @_;
+
+ return error("Unknown command: $command") unless($dispatch{$command});
+
+ my $output = &{$dispatch{$command}}($data,$config);
+ return $output;
+}
 
 # exec_show()
 #
@@ -51,7 +74,7 @@ use base qw(Exporter);
 #
 # Return: Output of the command (Scalar Reference)
 
-sub exec_show($$$)
+sub exec_show($$)
 {
  my ($data,$config) = @_;
  my $physical       = $data->{'physical'};
@@ -63,14 +86,14 @@ sub exec_show($$$)
   # Create directory listing
 
   my $direntries = dir_read($physical);
-  return error("Reading of directory $virtual failed") unless($direntries);
+  return error("Reading of directory $virtual failed.",upper_path($virtual)) unless($direntries);
 
   my $files = $direntries->{'files'};
   my $dirs  = $direntries->{'dirs'};
 
   $output .= htmlhead("Directory listing of $virtual");
   $output .= equal_url($config->{'httproot'},$virtual);
-  $output .=  "<hr>\n\n<pre>\n";
+  $output .= "<hr>\n\n<pre>\n";
 
   # Create the link to the upper directory
   # (only if we are not in the root directory)
@@ -83,10 +106,10 @@ sub exec_show($$$)
    $output .= "  [SUBDIR]  ";
    $output .= strftime("%d.%m.%Y %H:%M",localtime($stat[9]));
    $output .= " " x 10;
-   $output .= "<a href=\"$script?command=show&file=".upper_path($virtual)."\">../</a>\n";
+   $output .= "<a href=\"$script?command=show&file=".encode_entities(upper_path($virtual))."\">../</a>\n";
   }
 
-  # Get the longest file/directory name
+  # Get the length of the longest file/directory name
 
   my $max_name_len = 0;
 
@@ -100,21 +123,24 @@ sub exec_show($$$)
 
   foreach my $dir(@$dirs)
   {
-   my @stat = stat($physical."/".$dir);
+   my @stat      = stat($physical."/".$dir);
+   my $virt_path = encode_entities($virtual.$dir."/");
 
    $output .= "  ";
    $output .= "[SUBDIR]  ";
-   $output .= strftime("%d.%m.%Y %H:%M",localtime($stat[9]));
+   $output .= strftime($config->{'timeformat'},localtime($stat[9]));
    $output .= " " x 10;
-   $output .= "<a href=\"$script?command=show&file=$virtual$dir/\">".encode_entities($dir)."/</a>\n";
+   $output .= "<a href=\"$script?command=show&file=$virt_path\">".encode_entities($dir)."/</a>";
+   $output .= " " x ($max_name_len - length($dir) - 1)."\t  (";
+   $output .= "<a href=\"$script?command=workwithdir&file=$virt_path\">Work with directory</a>)\n";
   }
 
   # Files
 
   foreach my $file(@$files)
   {
-   my $phys_path = $physical."/".$file; # Not exactly...
-   my $virt_path = $virtual.$file;
+   my $phys_path = $physical."/".$file;
+   my $virt_path = encode_entities($virtual.$file);
 
    my @stat      = stat($phys_path);
    my $in_use    = $data->{'uselist'}->in_use($virtual.$file);
@@ -122,34 +148,74 @@ sub exec_show($$$)
    $output .= " " x (10 - length($stat[7]));
    $output .= $stat[7];
    $output .= "  ";
-   $output .= strftime("%d.%m.%Y %H:%M",localtime($stat[9]));
-   $output .= ($in_use) ? " (IN USE) " : (-B $phys_path) ? " (BINARY) " : " " x 10;
+   $output .= strftime($config->{'timeformat'},localtime($stat[9]));
+   $output .= " " x 10;
    $output .= encode_entities($file);
    $output .= " " x ($max_name_len - length($file))."\t  (";
 
-   $output .= (-T $phys_path)
-              ? "<a href=\"$script?command=show&file=$virt_path\">View</a>"
-              : '<span style="color:#C0C0C0">View</span>';
+   # Link "View"
+
+   if(-r $phys_path && -T $phys_path)
+   {
+    $output .= "<a href=\"$script?command=show&file=$virt_path\">View</a>";
+   }
+   else
+   {
+    $output .= '<span style="color:#C0C0C0" title="';
+
+    $output .= (not -r $phys_path) ? "Not readable" :
+               (-B     $phys_path) ? "Binary file"  : "";
+
+    $output .= '">View</span>';
+   }
 
    $output .= " | ";
 
-   $output .= ($in_use || -B $phys_path)
-              ? '<span style="color:#C0C0C0">Edit</span>'
-              : "<a href=\"$script?command=beginedit&file=$virt_path\">Edit</a>";
+   # Link "Edit"
+
+   if(-w $phys_path && -r $phys_path && -T $phys_path && not $in_use)
+   {
+    $output .= "<a href=\"$script?command=beginedit&file=$virt_path\">Edit</a>";
+   }
+   else
+   {
+    $output .= '<span style="color:#C0C0C0" title="';
+
+    $output .= (not -r $phys_path) ? "Not readable" :
+               (not -w $phys_path) ? "Read only"    :
+               (-B     $phys_path) ? "Binary file"  :
+               ($in_use)           ? "In use"       : "";
+
+    $output .= '">Edit</span>';
+   }
 
-   $output .= " | <a href=\"$script?command=workwithfile&file=$virt_path\">Do other stuff</a>)\n";
+   # Link "Do other stuff"
+
+   $output .= " | <a href=\"$script?command=workwithfile&file=$virt_path\">Work with file</a>)\n";
   }
 
   $output .= "</pre>\n\n<hr>\n\n";
+
+  # Bottom of directory listing
+  # (Fields for creating files and directories)
+
   $output .= <<END;
 <table border="0">
 <tr>
+<form action="$script">
+<input type="hidden" name="command" value="mkdir">
+<input type="hidden" name="curdir" value="$virtual">
 <td>Create new directory:</td>
-<td>$virtual <input type="text" name="newdirname"> <input type="submit" value="Create!"></td>
+<td>$virtual <input type="text" name="newfile"> <input type="submit" value="Create!"></td>
+</form>
 </tr>
 <tr>
 <td>Create new file:</td>
-<td>$virtual <input type="text" name="newfilename"> <input type="submit" value="Create!"></td>
+<form action="$script">
+<input type="hidden" name="command" value="mkfile">
+<input type="hidden" name="curdir" value="$virtual">
+<td>$virtual <input type="text" name="newfile"> <input type="submit" value="Create!"></td>
+</form>
 </tr>
 </table>
 
@@ -161,19 +227,23 @@ END
  {
   # View a file
 
+  return error("You have not enough permissions to view this file.",upper_path($virtual)) unless(-r $physical);
+
   # Check on binary files
+  # We have to do it in this way, or empty files
+  # will be recognized as binary files
 
-  if(-B $physical)
+  unless(-T $physical)
   {
    # Binary file
 
-   return error("This editor is not able to view/edit binary files.");
+   return error("This editor is not able to view/edit binary files.",upper_path($virtual));
   }
   else
   {
    # Text file
 
-   $output  = htmlhead("Contents of file $virtual");
+   $output  = htmlhead("Contents of file ".encode_entities($virtual));
    $output .= equal_url($config->{'httproot'},$virtual);
    $output .= dir_link($virtual);
 
@@ -186,7 +256,7 @@ END
   }
  }
 
- return \$output
+ return \$output;
 }
 
 # exec_beginedit
@@ -205,16 +275,17 @@ sub exec_beginedit($$)
  my $virtual        = $data->{'virtual'};
  my $uselist        = $data->{'uselist'};
 
- return error("You cannot edit directories.") if(-d $physical);
+ return error("You cannot edit directories.",upper_path($virtual)) if(-d $physical);
  return error_in_use($virtual) if($uselist->in_use($virtual));
+ return error("You have not enough permissions to edit this file.",upper_path($virtual)) unless(-r $physical && -w $physical);
 
  # Check on binary files
 
if(-B $physical)
unless(-T $physical)
  {
   # Binary file
 
-  return error("This editor is not able to view/edit binary files.");
+  return error("This editor is not able to view/edit binary files.",upper_path($virtual));
  }
  else
  {
@@ -223,27 +294,33 @@ sub exec_beginedit($$)
   $uselist->add_file($virtual);
   $uselist->save;
 
-  my $dir     = upper_path($virtual);
-  my $content = encode_entities(${file_read($physical)});
+  my $dir       = upper_path($virtual);
+  my $content   = encode_entities(${file_read($physical)});
+
+  my $equal_url = equal_url($config->{'httproot'},$virtual);
+
+  $virtual   = encode_entities($virtual);
 
   my $output = htmlhead("Edit file $virtual");
-  $output   .= equal_url($config->{'httproot'},$virtual);
+  $output   .= $equal_url;
   $output   .= <<END;
 <p><b style="color:#FF0000">Caution!</b> This file is locked for other users while you are editing it. To unlock it, click <i>Save and exit</i> or <i>Exit WITHOUT saving</i>. Please <b>don't</b> click the <i>Reload</i> button in your browser! This will confuse the editor.</p>
 
-<form action="$ENV{'SCRIPT_NAME'}" method="get">
+<form action="$script" method="get">
 <input type="hidden" name="command" value="canceledit">
 <input type="hidden" name="file" value="$virtual">
 <p><input type="submit" value="Exit WITHOUT saving"></p>
 </form>
 
-<form action="$ENV{'SCRIPT_NAME'}" method="post">
+<form action="$script" method="post">
 <input type="hidden" name="command" value="endedit">
 <input type="hidden" name="file" value="$virtual">
 
 <table width="100%" border="1">
 <tr>
-<td width="50%" align="center"><input type="checkbox" name="save_as_new_file" value="1"> Save as new file: $dir <input type=text name="new_filename" value=""></td>
+<td width="50%" align="center">
+<input type="hidden" name="file" value="$virtual">
+<input type="checkbox" name="saveas" value="1"> Save as new file: $dir <input type=text name="newfile" value=""></td>
 <td width="50%" align="center"><input type="checkbox" name="encode_iso" value="1"> Encode ISO-8859-1 special chars</td>
 </tr>
 <tr>
@@ -279,6 +356,11 @@ sub exec_endedit($$)
  my $content        = $data->{'cgi'}->param('filecontent');
 
  return error("You cannot edit directories.") if(-d $physical);
+ return error("You have not enough permissions to edit this file.",upper_path($virtual)) unless(-r $physical && -w $physical);
+
+ # Normalize newlines
+
+ $content =~ s/\015\012|\012|\015/\n/g;
 
  if($data->{'cgi'}->param('encode_iso'))
  {
@@ -287,15 +369,23 @@ sub exec_endedit($$)
   $content = encode_entities($content,"\200-\377");
  }
 
+ if($data->{'cgi'}->param('saveas'))
+ {
+  # Create the new filename
+
+  $physical = $data->{'new_physical'};
+  $virtual  = $data->{'new_virtual'};
+ }
+
  if(file_save($physical,\$content))
  {
-  # Saving of the file was successfull - so unlock it!
+  # Saving of the file was successful - so unlock it!
 
   return exec_unlock($data,$config);
  }
  else
  {
-  return error("Saving of file '$virtual' failed'");
+  return error("Saving of file '".encode_entities($virtual)."' failed'.",upper_path($virtual));
  }
 }
 
@@ -310,7 +400,16 @@ sub exec_endedit($$)
 
 sub exec_mkfile($$)
 {
- 1;
+ my ($data,$config) = @_;
+ my $new_physical   = $data->{'new_physical'};
+ my $new_virtual    = $data->{'new_virtual'};
+ my $dir            = upper_path($new_virtual);
+ $new_virtual       = encode_entities($new_virtual);
+
+ return error("A file or directory called '$new_virtual' already exists.",$dir) if(-e $new_physical);
+
+ file_create($new_physical) or return error("Could not create file '$new_virtual'.",$dir);
+ return devedit_reload({command => 'show', file => $dir});
 }
 
 # exec_mkdir()
@@ -324,7 +423,16 @@ sub exec_mkfile($$)
 
 sub exec_mkdir($$)
 {
- 1;
+ my ($data,$config) = @_;
+ my $new_physical   = $data->{'new_physical'};
+ my $new_virtual    = $data->{'new_virtual'};
+ my $dir            = upper_path($new_virtual);
+ $new_virtual       = encode_entities($new_virtual);
+
+ return error("A file or directory called '$new_virtual' already exists.",$dir) if(-e $new_physical);
+
+ mkdir($new_physical,0777) or return error("Could not create directory '$new_virtual'.",$dir);
+ return devedit_reload({command => 'show', file => $dir});
 }
 
 # exec_workwithfile()
@@ -343,23 +451,37 @@ sub exec_workwithfile($$)
  my $virtual        = $data->{'virtual'};
  my $unused         = $data->{'uselist'}->unused($virtual);
 
- my $output = htmlhead("Work with file $virtual");
+ my $dir = encode_entities(upper_path($virtual));
+
+ my $output = htmlhead("Work with file ".encode_entities($virtual));
  $output   .= equal_url($config->{'httproot'},$virtual);
+
+ $virtual   = encode_entities($virtual);
+
  $output   .= dir_link($virtual);
  $output   .= "<p><b>Note:</b> On UNIX systems, filenames are <b>case-sensitive</b>!</p>\n\n";
 
  $output .= "<p>Someone else is currently editing this file. So not all features are available.</p>\n\n" unless($unused);
 
- $output .= <<END;
-<hr>
+ $output .= "<hr>\n\n";
 
+ # Copying of the file is always allowed - but we need read access
+
+ if(-r $physical)
+ {
+  $output .= <<END;
 <h2>Copy</h2>
 
-<p>Copy file '$virtual' to: <input type="text" name="newfilename" size="50"> <input type="submit" value="Copy!"></p>
+<form action="$script">
+<input type="hidden" name="command" value="copy">
+<input type="hidden" name="file" value="$virtual">
+<p>Copy file '$virtual' to:<br>$dir <input type="text" name="newfile" size="30"> <input type="submit" value="Copy!"></p>
+</form>
 
 <hr>
 
 END
+ }
 
  if($unused)
  {
@@ -369,16 +491,22 @@ END
   $output .= <<END;
 <h2>Move/rename</h2>
 
-<p>Move/Rename file '$virtual' to: <input type="text" name="newfilename" size="50"> <input type="submit" value="Move/Rename!"></p>
+<form action="$script">
+<input type="hidden" name="command" value="rename">
+<input type="hidden" name="file" value="$virtual">
+<p>Move/Rename file '$virtual' to:<br>$dir <input type="text" name="newfile" size="30"> <input type="submit" value="Move/Rename!"></p>
+</form>
 
 <hr>
 
 <h2>Delete</h2>
 
+<p>Click on the button below to remove the file '$virtual'.</p>
+
 <form action="$script" method="get">
 <input type="hidden" name="file" value="$virtual">
 <input type="hidden" name="command" value="remove">
-<p><input type="submit" value="Delete file '$virtual'!"></p>
+<p><input type="submit" value="Delete file!"></p>
 </form>
 END
  }
@@ -406,6 +534,60 @@ END
  return \$output;
 }
 
+# exec_workwithdir()
+#
+# Display a form for renaming/deleting a directory
+#
+# Params: 1. Reference to user input hash
+#         2. Reference to config hash
+#
+# Return: Output of the command (Scalar Reference)
+
+sub exec_workwithdir($$)
+{
+ my ($data,$config) = @_;
+ my $physical       = $data->{'physical'};
+ my $virtual        = $data->{'virtual'};
+
+ my $dir = encode_entities(upper_path($virtual));
+
+ my $output = htmlhead("Work with directory ".encode_entities($virtual));
+ $output   .= equal_url($config->{'httproot'},$virtual);
+
+ $virtual   = encode_entities($virtual);
+
+ $output   .= dir_link($virtual);
+ $output   .= "<p><b>Note:</b> On UNIX systems, filenames are <b>case-sensitive</b>!</p>\n\n";
+ $output .= "<hr>\n\n";
+
+ $output .= <<END;
+<h2>Move/rename</h2>
+
+<form action="$script">
+<input type="hidden" name="command" value="rename">
+<input type="hidden" name="file" value="$virtual">
+<p>Move/Rename directory '$virtual' to: $dir <input type="text" name="newfile" size="50"> <input type="submit" value="Move/Rename!"></p>
+</form>
+
+<hr>
+
+<h2>Delete</h2>
+
+<p>Click on the button below to completely remove the directory '$virtual' and oll of it's files and sub directories.</p>
+
+<form action="$script" method="get">
+<input type="hidden" name="file" value="$virtual">
+<input type="hidden" name="command" value="rmdir">
+<p><input type="submit" value="Delete!"></p>
+</form>
+END
+
+ $output .= "\n<hr>";
+ $output .= htmlfoot;
+
+ return \$output;
+}
+
 # exec_copy()
 #
 # Copy a file and return to directory view
@@ -417,7 +599,24 @@ END
 
 sub exec_copy($$)
 {
- 1;
+ my ($data,$config) = @_;
+ my $physical       = $data->{'physical'};
+ my $virtual        = encode_entities($data->{'virtual'});
+ my $new_physical   = $data->{'new_physical'};
+ my $new_virtual    = $data->{'new_virtual'};
+ my $dir            = upper_path($new_virtual);
+ $new_virtual       = encode_entities($new_virtual);
+
+ return error("This editor is not able to copy directories.") if(-d $physical);
+ return error("You have not enough permissions to copy this file.") unless(-r $physical);
+
+ if(-e $new_physical)
+ {
+  return error("A file or directory called '$new_virtual' already exists and this editor is currently not able to ask to overwrite the existing file or directory.",upper_path($virtual));
+ }
+
+ copy($physical,$new_physical) or return error("Could not copy '$virtual' to '$new_virtual'",upper_path($virtual));
+ return devedit_reload({command => 'show', file => $dir});
 }
 
 # exec_rename()
@@ -431,7 +630,23 @@ sub exec_copy($$)
 
 sub exec_rename($$)
 {
- 1;
+ my ($data,$config) = @_;
+ my $physical       = $data->{'physical'};
+ my $virtual        = $data->{'virtual'};
+ my $new_physical   = $data->{'new_physical'};
+ my $new_virtual    = $data->{'new_virtual'};
+ my $dir            = upper_path($new_virtual);
+ $new_virtual       = encode_entities($new_virtual);
+
+ return error_in_use($virtual) if($data->{'uselist'}->in_use($virtual));
+
+ if(-e $new_physical)
+ {
+  return error("A file or directory called '$new_virtual' already exists and this editor is currently not able to ask to overwrite the existing file or directory.",upper_path($virtual));
+ }
+
+ rename($physical,$new_physical) or return error("Could not move/rename '".encode_entities($virtual)."' to '$new_virtual'.",upper_path($virtual));
+ return devedit_reload({command => 'show', file => $dir});
 }
 
 # exec_remove()
@@ -449,14 +664,68 @@ sub exec_remove($$)
  my $physical       = $data->{'physical'};
  my $virtual        = $data->{'virtual'};
 
- return error_in_use($virtual) if($data->{'uselist'}->in_use($virtual));
+ return exec_rmdir($data,$config) if(-d $physical);
+ return error_in_use($virtual)    if($data->{'uselist'}->in_use($virtual));
+
+ unlink($physical) or return error("Could not delete file '".encode_entities($virtual)."'.",upper_path($virtual));
+ return devedit_reload({command => 'show', file => upper_path($virtual)});
+}
+
+# exec_rmdir()
+#
+# Remove a directory and return to directory view
+#
+# Params: 1. Reference to user input hash
+#         2. Reference to config hash
+#
+# Return: Output of the command (Scalar Reference)
+
+sub exec_rmdir($$)
+{
+ my ($data,$config) = @_;
+ my $physical       = $data->{'physical'};
+ my $virtual        = $data->{'virtual'};
+
+ if($data->{'cgi'}->param('confirmed'))
+ {
+  rmtree($physical);
+  return devedit_reload({command => 'show', file => upper_path($virtual)});
+ }
+ else
+ {
+  my $dir = encode_entities(upper_path($virtual));
+  my $output;
 
- my $dir = upper_path($virtual);
+  $output  = htmlhead("Remove directory $virtual");
+  $output .= equal_url($config->{'httproot'},$virtual);
 
unlink($physical) or return error("Could not delete file '$virtual'.");
 $virtual = encode_entities($virtual);
 
- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=$dir");
- return \$output;
+  $output .= dir_link($virtual);
+
+  $output .= <<"END";
+<p>Do you really want to remove the directory '$virtual' and all of it's files and sub directories?</p>
+
+<form action="$script" method="get">
+<input type="hidden" name="command" value="rmdir">
+<input type="hidden" name="file" value="$virtual">
+<input type="hidden" name="confirmed" value="1">
+
+<input type="submit" value="Yes">
+</form>
+
+<form action="$script" method="get">
+<input type="hidden" name="command" value="show">
+<input type="hidden" name="file" value="$dir">
+
+<input type="submit" value="No">
+</form>
+END
+
+  $output .= htmlfoot;
+
+  return \$output;
+ }
 }
 
 # exec_unlock()
@@ -472,17 +741,13 @@ sub exec_remove($$)
 sub exec_unlock($$)
 {
  my ($data,$config) = @_;
- my $physical       = $data->{'physical'};
  my $virtual        = $data->{'virtual'};
  my $uselist        = $data->{'uselist'};
 
- my $dir = upper_path($virtual);
-
  $uselist->remove_file($virtual);
  $uselist->save;
 
- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=$dir");
- return \$output;
+ return devedit_reload({command => 'show', file => upper_path($virtual)});
 }
 
 # it's true, baby ;-)

patrick-canterino.de