- Cleaned the comments

[devedit.git] / modules / Command.pm

diff --git a/modules/Command.pm b/modules/Command.pm
index 751392f21a31e2c5e8ab9f32ae5d5aada206a2b4..635d43d2906e6f13be3eaa391b00699854e2254f 100644 (file)
--- a/modules/Command.pm
+++ b/modules/Command.pm
@@ -6,40 +6,64 @@ package Command;
 # Execute Dev-Editor's commands
 #
 # Author:        Patrick Canterino <patshaping@gmx.net>
 # Execute Dev-Editor's commands
 #
 # Author:        Patrick Canterino <patshaping@gmx.net>

-# Last modified: 2003-10-27
+# Last modified: 2003-12-02

 #
 
 use strict;
 
 #
 
 use strict;
 

-use vars qw(@EXPORT
-            $script);
-
-use CGI qw(redirect);
+use vars qw(@EXPORT);

 
 use File::Access;
 use File::Copy;
 
 use File::Access;
 use File::Copy;

+use File::Path;

 
 use HTML::Entities;
 use Output;
 use POSIX qw(strftime);
 use Tool;
 
 
 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 ###
 
 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()
 #
 
 # exec_show()
 #


@@ -50,7 +74,7 @@ use base qw(Exporter);
 #
 # Return: Output of the command (Scalar Reference)
 
 #
 # Return: Output of the command (Scalar Reference)
 

-sub exec_show($$$)
+sub exec_show($$)

 {
  my ($data,$config) = @_;
  my $physical       = $data->{'physical'};
 {
  my ($data,$config) = @_;
  my $physical       = $data->{'physical'};


@@ -62,7 +86,7 @@ sub exec_show($$$)
   # Create directory listing
 
   my $direntries = dir_read($physical);
   # 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'};
 
   my $files = $direntries->{'files'};
   my $dirs  = $direntries->{'dirs'};


@@ -99,13 +123,16 @@ sub exec_show($$$)
 
   foreach my $dir(@$dirs)
   {
 
   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($config->{'timeformat'},localtime($stat[9]));
    $output .= " " x 10;
 
    $output .= "  ";
    $output .= "[SUBDIR]  ";
    $output .= strftime($config->{'timeformat'},localtime($stat[9]));
    $output .= " " x 10;

-   $output .= "<a href=\"$script?command=show&file=".encode_entities($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
   }
 
   # Files


@@ -122,21 +149,49 @@ sub exec_show($$$)
    $output .= $stat[7];
    $output .= "  ";
    $output .= strftime($config->{'timeformat'},localtime($stat[9]));
    $output .= $stat[7];
    $output .= "  ";
    $output .= strftime($config->{'timeformat'},localtime($stat[9]));

-   $output .= ($in_use) ? " (IN USE) " : (not -T $phys_path) ? " (BINARY) " : " " x 10;
+   $output .= " " x 10;

    $output .= encode_entities($file);
    $output .= " " x ($max_name_len - length($file))."\t  (";
 
    $output .= encode_entities($file);
    $output .= " " x ($max_name_len - length($file))."\t  (";
 

-   $output .= (-r $phys_path && -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 .= " | ";
 

-   $output .= (-w $phys_path && -r $phys_path && -T $phys_path && not $in_use)
-              ? "<a href=\"$script?command=beginedit&file=$virt_path\">Edit</a>"
-              : '<span style="color:#C0C0C0">Edit</span>';
+   # Link "Edit"

 
 

-   $output .= " | <a href=\"$script?command=workwithfile&file=$virt_path\">Do other stuff</a>)\n";
+   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>';
+   }
+
+   # 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";
   }
 
   $output .= "</pre>\n\n<hr>\n\n";


@@ -172,7 +227,7 @@ END
  {
   # View a file
 
  {
   # View a file
 

-  return error("You have not enough permissions to view this file.") unless(-r $physical);
+  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
 
   # Check on binary files
   # We have to do it in this way, or empty files


@@ -182,7 +237,7 @@ END
   {
    # Binary file
 
   {
    # 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
   {
   }
   else
   {


@@ -220,9 +275,9 @@ sub exec_beginedit($$)
  my $virtual        = $data->{'virtual'};
  my $uselist        = $data->{'uselist'};
 
  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_in_use($virtual) if($uselist->in_use($virtual));

- return error("You have not enough permissions to edit this file.") unless(-r $physical && -w $physical);
+ return error("You have not enough permissions to edit this file.",upper_path($virtual)) unless(-r $physical && -w $physical);

 
  # Check on binary files
 
 
  # Check on binary files
 


@@ -230,7 +285,7 @@ sub exec_beginedit($$)
  {
   # Binary file
 
  {
   # 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
  {
  }
  else
  {


@@ -301,7 +356,7 @@ sub exec_endedit($$)
  my $content        = $data->{'cgi'}->param('filecontent');
 
  return error("You cannot edit directories.") if(-d $physical);
  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.") unless(-r $physical && -w $physical);
+ return error("You have not enough permissions to edit this file.",upper_path($virtual)) unless(-r $physical && -w $physical);

 
  # Normalize newlines
 
 
  # Normalize newlines
 


@@ -354,9 +409,7 @@ sub exec_mkfile($$)
  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 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);

-
- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=$dir");
- return \$output;
+ return devedit_reload({command => 'show', file => $dir});

 }
 
 # exec_mkdir()
 }
 
 # exec_mkdir()


@@ -378,10 +431,8 @@ sub exec_mkdir($$)
 
  return error("A file or directory called '$new_virtual' already exists.",$dir) if(-e $new_physical);
 
 
  return error("A file or directory called '$new_virtual' already exists.",$dir) if(-e $new_physical);
 

- mkdir($new_physical) or return error("Could not create directory '$new_virtual'.",$dir);
-
- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=$dir");
- return \$output;
+ mkdir($new_physical,0777) or return error("Could not create directory '$new_virtual'.",$dir);
+ return devedit_reload({command => 'show', file => $dir});

 }
 
 # exec_workwithfile()
 }
 
 # exec_workwithfile()


@@ -412,19 +463,19 @@ sub exec_workwithfile($$)
 
  $output .= "<p>Someone else is currently editing this file. So not all features are available.</p>\n\n" unless($unused);
 
 
  $output .= "<p>Someone else is currently editing this file. So not all features are available.</p>\n\n" unless($unused);
 

- # Copying of the file as always allowed if we have read access
+ $output .= "<hr>\n\n";
+
+ # Copying of the file is always allowed - but we need read access

 
  if(-r $physical)
  {
   $output .= <<END;
 
  if(-r $physical)
  {
   $output .= <<END;

-<hr>
-

 <h2>Copy</h2>
 
 <form action="$script">
 <input type="hidden" name="command" value="copy">
 <input type="hidden" name="file" value="$virtual">
 <h2>Copy</h2>
 
 <form action="$script">
 <input type="hidden" name="command" value="copy">
 <input type="hidden" name="file" value="$virtual">

-<p>Copy file '$virtual' to: $dir <input type="text" name="newfile" size="50"> <input type="submit" value="Copy!"></p>
+<p>Copy file '$virtual' to:<br>$dir <input type="text" name="newfile" size="30"> <input type="submit" value="Copy!"></p>

 </form>
 
 <hr>
 </form>
 
 <hr>


@@ -443,17 +494,19 @@ END
 <form action="$script">
 <input type="hidden" name="command" value="rename">
 <input type="hidden" name="file" value="$virtual">
 <form action="$script">
 <input type="hidden" name="command" value="rename">
 <input type="hidden" name="file" value="$virtual">

-<p>Move/Rename file '$virtual' to: $dir <input type="text" name="newfile" size="50"> <input type="submit" value="Move/Rename!"></p>
+<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>
 
 </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">
 <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
  }
 </form>
 END
  }


@@ -481,6 +534,60 @@ END
  return \$output;
 }
 
  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
 # exec_copy()
 #
 # Copy a file and return to directory view


@@ -509,9 +616,7 @@ sub exec_copy($$)
  }
 
  copy($physical,$new_physical) or return error("Could not copy '$virtual' to '$new_virtual'",upper_path($virtual));
  }
 
  copy($physical,$new_physical) or return error("Could not copy '$virtual' to '$new_virtual'",upper_path($virtual));

-
- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=$dir");
- return \$output;
+ return devedit_reload({command => 'show', file => $dir});

 }
 
 # exec_rename()
 }
 
 # exec_rename()


@@ -541,9 +646,7 @@ sub exec_rename($$)
  }
 
  rename($physical,$new_physical) or return error("Could not move/rename '".encode_entities($virtual)."' to '$new_virtual'.",upper_path($virtual));
  }
 
  rename($physical,$new_physical) or return error("Could not move/rename '".encode_entities($virtual)."' to '$new_virtual'.",upper_path($virtual));

-
- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=$dir");
- return \$output;
+ return devedit_reload({command => 'show', file => $dir});

 }
 
 # exec_remove()
 }
 
 # exec_remove()


@@ -561,13 +664,68 @@ sub exec_remove($$)
  my $physical       = $data->{'physical'};
  my $virtual        = $data->{'virtual'};
 
  my $physical       = $data->{'physical'};
  my $virtual        = $data->{'virtual'};
 

- return error("Deleting directories is currently unsupported.") if(-d $physical);
- 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));
 
  unlink($physical) or return error("Could not delete file '".encode_entities($virtual)."'.",upper_path($virtual));

+ return devedit_reload({command => 'show', file => upper_path($virtual)});
+}

 
 

- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=".upper_path($virtual));
- return \$output;
+# 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;
+
+  $output  = htmlhead("Remove directory $virtual");
+  $output .= equal_url($config->{'httproot'},$virtual);
+
+  $virtual = encode_entities($virtual);
+
+  $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()
 }
 
 # exec_unlock()


@@ -589,8 +747,7 @@ sub exec_unlock($$)
  $uselist->remove_file($virtual);
  $uselist->save;
 
  $uselist->remove_file($virtual);
  $uselist->save;
 

- my $output = redirect("http://$ENV{'HTTP_HOST'}$script?command=show&file=".upper_path($virtual));
- return \$output;
+ return devedit_reload({command => 'show', file => upper_path($virtual)});

 }
 
 # it's true, baby ;-)
 }
 
 # it's true, baby ;-)