* [PATCH v7 1/7] git-remote-mediawiki: Introduction of Git::Mediawiki.pm
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
@ 2013-07-02 22:39 ` benoit.person
2013-07-02 22:59 ` Junio C Hamano
2013-07-02 22:39 ` [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable benoit.person
` (5 subsequent siblings)
6 siblings, 1 reply; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
Currently, the mw-to-git project contains only a remote helper
(git-remote-mediawiki.perl). To improve the user experience while
working with mediawiki remotes, new tools, designed for such cases,
should be created. To achieve this goal, the project needs a way to
share code between several scripts (remote helper, commands, ... ).
A perl package offers the best way to handle such case: Each script
can select what should be imported in its namespace. The package
namespacing limits the use of side effects in the shared code.
An alternate solution is to concatenate a "toolset" file with each
*.perl when 'make'-ing the project. In that scheme, everything is
imported in the script's namespace. Plus, files should be renamed in
order to chain to Git's toplevel makefile. Hence, this solution is not
acceptable.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
contrib/mw-to-git/Git/Mediawiki.pm | 24 ++++++++++++++++++++++++
contrib/mw-to-git/Makefile | 24 +++++++++++++++++++++---
2 files changed, 45 insertions(+), 3 deletions(-)
create mode 100644 contrib/mw-to-git/Git/Mediawiki.pm
diff --git a/contrib/mw-to-git/Git/Mediawiki.pm b/contrib/mw-to-git/Git/Mediawiki.pm
new file mode 100644
index 0000000..805f42a
--- /dev/null
+++ b/contrib/mw-to-git/Git/Mediawiki.pm
@@ -0,0 +1,24 @@
+package Git::Mediawiki;
+
+use 5.008;
+use strict;
+use Git;
+
+BEGIN {
+
+our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
+
+# Totally unstable API.
+$VERSION = '0.01';
+
+require Exporter;
+
+@ISA = qw(Exporter);
+
+@EXPORT = ();
+
+# Methods which can be called as standalone functions as well:
+@EXPORT_OK = ();
+}
+
+1; # Famous last words
diff --git a/contrib/mw-to-git/Makefile b/contrib/mw-to-git/Makefile
index 1fb2424..a6f8b24 100644
--- a/contrib/mw-to-git/Makefile
+++ b/contrib/mw-to-git/Makefile
@@ -2,18 +2,36 @@
# Copyright (C) 2013
# Matthieu Moy <Matthieu.Moy@imag.fr>
#
-## Build git-remote-mediawiki
+# To install, run Git's toplevel 'make install' then run:
+#
+# make install
+GIT_MEDIAWIKI_PM=Git/Mediawiki.pm
SCRIPT_PERL=git-remote-mediawiki.perl
GIT_ROOT_DIR=../..
HERE=contrib/mw-to-git/
SCRIPT_PERL_FULL=$(patsubst %,$(HERE)/%,$(SCRIPT_PERL))
+INSTLIBDIR=$(shell $(MAKE) -C $(GIT_ROOT_DIR)/perl \
+ -s --no-print-directory instlibdir)
all: build
-build install clean:
+install_pm:
+ install $(GIT_MEDIAWIKI_PM) $(INSTLIBDIR)/$(GIT_MEDIAWIKI_PM)
+
+build:
+ $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL=$(SCRIPT_PERL_FULL) \
+ build-perl-script
+
+install: install_pm
$(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL=$(SCRIPT_PERL_FULL) \
- $@-perl-script
+ install-perl-script
+
+clean:
+ $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL=$(SCRIPT_PERL_FULL) \
+ clean-perl-script
+ rm $(INSTLIBDIR)/$(GIT_MEDIAWIKI_PM)
+
perlcritic:
perlcritic -2 *.perl
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread* Re: [PATCH v7 1/7] git-remote-mediawiki: Introduction of Git::Mediawiki.pm
2013-07-02 22:39 ` [PATCH v7 1/7] git-remote-mediawiki: Introduction of Git::Mediawiki.pm benoit.person
@ 2013-07-02 22:59 ` Junio C Hamano
0 siblings, 0 replies; 20+ messages in thread
From: Junio C Hamano @ 2013-07-02 22:59 UTC (permalink / raw)
To: benoit.person; +Cc: git, Celestin Matte, Matthieu Moy
benoit.person@ensimag.fr writes:
> From: Benoit Person <benoit.person@ensimag.fr>
>
> Currently, the mw-to-git project contains only a remote helper
> (git-remote-mediawiki.perl). To improve the user experience while
> working with mediawiki remotes, new tools, designed for such cases,
> should be created.
The above is too vague to be meaningful justification behind "should
be created". It is unclear what "new tools" are being built, what
the success criteria to judge such "new tools" to see if they are
well "designed for such cases", etc.
Perhaps you meant something like "we would want to allow the user
to preview what he has edited locally before pushing it out".
> To achieve this goal, the project needs a way to
> share code between several scripts (remote helper, commands, ... ).
That is sensible, no matter what new things you are building, you
would want to build them on a solid foundation.
^ permalink raw reply [flat|nested] 20+ messages in thread
* [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
2013-07-02 22:39 ` [PATCH v7 1/7] git-remote-mediawiki: Introduction of Git::Mediawiki.pm benoit.person
@ 2013-07-02 22:39 ` benoit.person
2013-07-02 23:01 ` Junio C Hamano
` (2 more replies)
2013-07-02 22:39 ` [PATCH v7 3/7] git-remote-mediawiki: New git bin-wrapper for developement benoit.person
` (4 subsequent siblings)
6 siblings, 3 replies; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
For now, bin-wrappers (based on wrap-for-bin.sh) redefine some
environnement variables (like $GITPERLLIB). If we want to chain to
those scripts and define one of those variables before, our changes
will be overwritten.
This patch simply makes the bin-wrappers prepend their modifications
rather than redefine the vars.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
wrap-for-bin.sh | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/wrap-for-bin.sh b/wrap-for-bin.sh
index 53a8dd0..dbebe49 100644
--- a/wrap-for-bin.sh
+++ b/wrap-for-bin.sh
@@ -14,7 +14,7 @@ else
GIT_TEMPLATE_DIR='@@BUILD_DIR@@/templates/blt'
export GIT_TEMPLATE_DIR
fi
-GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'
+GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib:'"$GITPERLLIB"
GIT_TEXTDOMAINDIR='@@BUILD_DIR@@/po/build/locale'
PATH='@@BUILD_DIR@@/bin-wrappers:'"$PATH"
export GIT_EXEC_PATH GITPERLLIB PATH GIT_TEXTDOMAINDIR
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-02 22:39 ` [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable benoit.person
@ 2013-07-02 23:01 ` Junio C Hamano
2013-07-02 23:19 ` Benoît Person
2013-07-03 10:30 ` Michael Haggerty
2013-07-03 10:57 ` Matthieu Moy
2 siblings, 1 reply; 20+ messages in thread
From: Junio C Hamano @ 2013-07-02 23:01 UTC (permalink / raw)
To: benoit.person; +Cc: git, Celestin Matte, Matthieu Moy
benoit.person@ensimag.fr writes:
> From: Benoit Person <benoit.person@ensimag.fr>
>
> For now, bin-wrappers (based on wrap-for-bin.sh) redefine some
> environnement variables (like $GITPERLLIB). If we want to chain to
> those scripts and define one of those variables before, our changes
> will be overwritten.
>
> This patch simply makes the bin-wrappers prepend their modifications
> rather than redefine the vars.
>
> Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
> ---
> wrap-for-bin.sh | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/wrap-for-bin.sh b/wrap-for-bin.sh
> index 53a8dd0..dbebe49 100644
> --- a/wrap-for-bin.sh
> +++ b/wrap-for-bin.sh
> @@ -14,7 +14,7 @@ else
> GIT_TEMPLATE_DIR='@@BUILD_DIR@@/templates/blt'
> export GIT_TEMPLATE_DIR
> fi
> -GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'
> +GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib:'"$GITPERLLIB"
Do we want to add that ':' unconditionally? Could GITPERLLIB be
empty?
> GIT_TEXTDOMAINDIR='@@BUILD_DIR@@/po/build/locale'
> PATH='@@BUILD_DIR@@/bin-wrappers:'"$PATH"
> export GIT_EXEC_PATH GITPERLLIB PATH GIT_TEXTDOMAINDIR
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-02 23:01 ` Junio C Hamano
@ 2013-07-02 23:19 ` Benoît Person
2013-07-03 8:54 ` Junio C Hamano
0 siblings, 1 reply; 20+ messages in thread
From: Benoît Person @ 2013-07-02 23:19 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Git Mailing List, Celestin Matte, Matthieu Moy
> Do we want to add that ':' unconditionally? Could GITPERLLIB be
> empty?
For now, GITPERLLIB is only used in that kind of statements:
use lib (split(/:/, $ENV{GITPERLLIB} || ... ));
The trailing ':' does not really matter, split will ignore it.
With the current codebase, I think it's nicer to do it that way (makes
wrap-for-bin.sh more readable).
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-02 23:19 ` Benoît Person
@ 2013-07-03 8:54 ` Junio C Hamano
2013-07-03 9:46 ` Benoît Person
0 siblings, 1 reply; 20+ messages in thread
From: Junio C Hamano @ 2013-07-03 8:54 UTC (permalink / raw)
To: Benoît Person; +Cc: Git Mailing List, Celestin Matte, Matthieu Moy
Benoît Person <benoit.person@ensimag.fr> writes:
>> Do we want to add that ':' unconditionally? Could GITPERLLIB be
>> empty?
>
> For now, GITPERLLIB is only used in that kind of statements:
> use lib (split(/:/, $ENV{GITPERLLIB} || ... ));
>
> The trailing ':' does not really matter, split will ignore it.
That may be true with the current use, but "For now" leaves funny
taste, doesn't it?
It is not too much trouble to fix by writing
GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'"${GITPERLLIB:+:$GITPERLLIB}"
and we will not have to be worried about future changes breaking
today's assumption.
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-03 8:54 ` Junio C Hamano
@ 2013-07-03 9:46 ` Benoît Person
0 siblings, 0 replies; 20+ messages in thread
From: Benoît Person @ 2013-07-03 9:46 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Git Mailing List, Celestin Matte, Matthieu Moy
>> For now, GITPERLLIB is only used in that kind of statements:
>> use lib (split(/:/, $ENV{GITPERLLIB} || ... ));
>>
>> The trailing ':' does not really matter, split will ignore it.
>
> That may be true with the current use, but "For now" leaves funny
> taste, doesn't it?
definitely. For me, the issue was that we were trading that "funny
taste" for less
readable code in wrap-for-bin.sh but with that default-substitution
construct, it seems
worth it. (a huge if-block seemed even funnier in fact :) )
> It is not too much trouble to fix by writing
>
> GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'"${GITPERLLIB:+:$GITPERLLIB}"
>
> and we will not have to be worried about future changes breaking
> today's assumption.
That construct is really nice :) did not know there was such a thing
in bash, thanks.
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-02 22:39 ` [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable benoit.person
2013-07-02 23:01 ` Junio C Hamano
@ 2013-07-03 10:30 ` Michael Haggerty
2013-07-03 10:57 ` Matthieu Moy
2 siblings, 0 replies; 20+ messages in thread
From: Michael Haggerty @ 2013-07-03 10:30 UTC (permalink / raw)
To: benoit.person; +Cc: git, Celestin Matte, Matthieu Moy, Junio C Hamano
On 07/03/2013 12:39 AM, benoit.person@ensimag.fr wrote:
> From: Benoit Person <benoit.person@ensimag.fr>
>
> For now, bin-wrappers (based on wrap-for-bin.sh) redefine some
> environnement variables (like $GITPERLLIB). If we want to chain to
> those scripts and define one of those variables before, our changes
> will be overwritten.
>
> This patch simply makes the bin-wrappers prepend their modifications
> rather than redefine the vars.
Your commit message makes it sound like GITPERLLIB is only one example
of a general class of environment variables fixed by the patch, but in
fact the patch address *only* GITPERLLIB. Please make the commit
message better match the patch.
And maybe you could mention for posterity whether you have seen other
variables that will need fixing vs. you did an audit and think that
GITPERLLIB is the only problematic one vs. you haven't looked for other
similar problems at all. This could save some time for the next person
with a similar itch and/or maybe inspire somebody to do an audit.
Thanks,
Michael
> Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
> ---
> wrap-for-bin.sh | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/wrap-for-bin.sh b/wrap-for-bin.sh
> index 53a8dd0..dbebe49 100644
> --- a/wrap-for-bin.sh
> +++ b/wrap-for-bin.sh
> @@ -14,7 +14,7 @@ else
> GIT_TEMPLATE_DIR='@@BUILD_DIR@@/templates/blt'
> export GIT_TEMPLATE_DIR
> fi
> -GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'
> +GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib:'"$GITPERLLIB"
> GIT_TEXTDOMAINDIR='@@BUILD_DIR@@/po/build/locale'
> PATH='@@BUILD_DIR@@/bin-wrappers:'"$PATH"
> export GIT_EXEC_PATH GITPERLLIB PATH GIT_TEXTDOMAINDIR
>
--
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-02 22:39 ` [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable benoit.person
2013-07-02 23:01 ` Junio C Hamano
2013-07-03 10:30 ` Michael Haggerty
@ 2013-07-03 10:57 ` Matthieu Moy
2013-07-03 20:24 ` Junio C Hamano
2 siblings, 1 reply; 20+ messages in thread
From: Matthieu Moy @ 2013-07-03 10:57 UTC (permalink / raw)
To: benoit.person; +Cc: git, Celestin Matte, Junio C Hamano
benoit.person@ensimag.fr writes:
> diff --git a/wrap-for-bin.sh b/wrap-for-bin.sh
> index 53a8dd0..dbebe49 100644
> --- a/wrap-for-bin.sh
> +++ b/wrap-for-bin.sh
> @@ -14,7 +14,7 @@ else
> GIT_TEMPLATE_DIR='@@BUILD_DIR@@/templates/blt'
> export GIT_TEMPLATE_DIR
> fi
> -GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'
> +GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib:'"$GITPERLLIB"
Then you need to do something like this to prevent broken $GITPERLLIB in
user's configuration from interfering with the testsuite:
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -92,6 +92,7 @@ unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
print join("\n", @vars);
')
unset XDG_CONFIG_HOME
+unset GITPERLLIB
GIT_AUTHOR_EMAIL=author@example.com
GIT_AUTHOR_NAME='A U Thor'
GIT_COMMITTER_EMAIL=committer@example.com
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-03 10:57 ` Matthieu Moy
@ 2013-07-03 20:24 ` Junio C Hamano
2013-07-03 20:38 ` Matthieu Moy
0 siblings, 1 reply; 20+ messages in thread
From: Junio C Hamano @ 2013-07-03 20:24 UTC (permalink / raw)
To: Matthieu Moy; +Cc: benoit.person, git, Celestin Matte
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
> benoit.person@ensimag.fr writes:
>
>> diff --git a/wrap-for-bin.sh b/wrap-for-bin.sh
>> index 53a8dd0..dbebe49 100644
>> --- a/wrap-for-bin.sh
>> +++ b/wrap-for-bin.sh
>> @@ -14,7 +14,7 @@ else
>> GIT_TEMPLATE_DIR='@@BUILD_DIR@@/templates/blt'
>> export GIT_TEMPLATE_DIR
>> fi
>> -GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'
>> +GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib:'"$GITPERLLIB"
>
> Then you need to do something like this to prevent broken $GITPERLLIB in
> user's configuration from interfering with the testsuite:
>
> --- a/t/test-lib.sh
> +++ b/t/test-lib.sh
> @@ -92,6 +92,7 @@ unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
> print join("\n", @vars);
> ')
> unset XDG_CONFIG_HOME
> +unset GITPERLLIB
> GIT_AUTHOR_EMAIL=author@example.com
> GIT_AUTHOR_NAME='A U Thor'
> GIT_COMMITTER_EMAIL=committer@example.com
Yes, that is a good point.
It introduces a chicken-and-egg circularity for git-mw tests to use
the common test infrastructure by dot-sourcing this file, though,
no?
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-03 20:24 ` Junio C Hamano
@ 2013-07-03 20:38 ` Matthieu Moy
2013-07-03 21:50 ` Junio C Hamano
0 siblings, 1 reply; 20+ messages in thread
From: Matthieu Moy @ 2013-07-03 20:38 UTC (permalink / raw)
To: Junio C Hamano; +Cc: benoit.person, git, Celestin Matte
Junio C Hamano <gitster@pobox.com> writes:
> Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
>
>> benoit.person@ensimag.fr writes:
>>
>>> diff --git a/wrap-for-bin.sh b/wrap-for-bin.sh
>>> index 53a8dd0..dbebe49 100644
>>> --- a/wrap-for-bin.sh
>>> +++ b/wrap-for-bin.sh
>>> @@ -14,7 +14,7 @@ else
>>> GIT_TEMPLATE_DIR='@@BUILD_DIR@@/templates/blt'
>>> export GIT_TEMPLATE_DIR
>>> fi
>>> -GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib'
>>> +GITPERLLIB='@@BUILD_DIR@@/perl/blib/lib:'"$GITPERLLIB"
>>
>> Then you need to do something like this to prevent broken $GITPERLLIB in
>> user's configuration from interfering with the testsuite:
>>
>> --- a/t/test-lib.sh
>> +++ b/t/test-lib.sh
>> @@ -92,6 +92,7 @@ unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
>> print join("\n", @vars);
>> ')
>> unset XDG_CONFIG_HOME
>> +unset GITPERLLIB
>> GIT_AUTHOR_EMAIL=author@example.com
>> GIT_AUTHOR_NAME='A U Thor'
>> GIT_COMMITTER_EMAIL=committer@example.com
>
> Yes, that is a good point.
>
> It introduces a chicken-and-egg circularity for git-mw tests to use
> the common test infrastructure by dot-sourcing this file, though,
> no?
I don't get it. It Git Mediawiki's tests, the tests scripts source
test-lib.sh, that unsets GITPERLLIB. Then, it calls the
mw-to-git/bin-wrapper/git that sets it properly, and calls the
toplevel's bin-wrapper.
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
^ permalink raw reply [flat|nested] 20+ messages in thread* Re: [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable
2013-07-03 20:38 ` Matthieu Moy
@ 2013-07-03 21:50 ` Junio C Hamano
0 siblings, 0 replies; 20+ messages in thread
From: Junio C Hamano @ 2013-07-03 21:50 UTC (permalink / raw)
To: Matthieu Moy; +Cc: benoit.person, git, Celestin Matte
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
> I don't get it. It Git Mediawiki's tests, the tests scripts source
> test-lib.sh, that unsets GITPERLLIB. Then, it calls the
> mw-to-git/bin-wrapper/git that sets it properly, and calls the
> toplevel's bin-wrapper.
Ah, OK. I somehow was assuming that a wrapper sets GITPERLLIB to
point at mediawiki stuff before running tests, which is the other
way around.
Please ignore the noise, and thanks for a dose of sanity.
^ permalink raw reply [flat|nested] 20+ messages in thread
* [PATCH v7 3/7] git-remote-mediawiki: New git bin-wrapper for developement
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
2013-07-02 22:39 ` [PATCH v7 1/7] git-remote-mediawiki: Introduction of Git::Mediawiki.pm benoit.person
2013-07-02 22:39 ` [PATCH v7 2/7] wrap-for-bin: Make bin-wrappers chainable benoit.person
@ 2013-07-02 22:39 ` benoit.person
2013-07-02 23:04 ` Junio C Hamano
2013-07-02 22:39 ` [PATCH v7 4/7] git-remote-mediawiki: Update tests to run with the new bin-wrapper benoit.person
` (3 subsequent siblings)
6 siblings, 1 reply; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
The introduction of the Git::Mediawiki package makes it impossible to test,
without installation, git-remote-mediawiki and git-mw.
Using a git bin-wrapper enables us to define proper $GITPERLLIB to force the
use of the developement version of the Git::Mediawiki package, bypassing its
installed version if any.
An alternate solution was to 'install' all the files required at each build
but it pollutes the toplevel with untracked files.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
contrib/mw-to-git/Makefile | 6 ++++++
contrib/mw-to-git/bin-wrapper/git | 14 ++++++++++++++
2 files changed, 20 insertions(+)
create mode 100755 contrib/mw-to-git/bin-wrapper/git
diff --git a/contrib/mw-to-git/Makefile b/contrib/mw-to-git/Makefile
index a6f8b24..c5e66df 100644
--- a/contrib/mw-to-git/Makefile
+++ b/contrib/mw-to-git/Makefile
@@ -2,6 +2,12 @@
# Copyright (C) 2013
# Matthieu Moy <Matthieu.Moy@imag.fr>
#
+# To build and test:
+#
+# make:
+# bin-wrapper/git mw preview Some_page.mw
+# bin-wrapper/git clone mediawiki::http://example.com/wiki/
+#
# To install, run Git's toplevel 'make install' then run:
#
# make install
diff --git a/contrib/mw-to-git/bin-wrapper/git b/contrib/mw-to-git/bin-wrapper/git
new file mode 100755
index 0000000..1aa51f7
--- /dev/null
+++ b/contrib/mw-to-git/bin-wrapper/git
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# git executable wrapper script for Git-Mediawiki to run tests without
+# installing all the scripts and perl packages.
+
+GIT_ROOT_DIR=../../..
+GIT_EXEC_PATH=$(cd "$(dirname "$0")" && cd ${GIT_ROOT_DIR} && pwd)
+
+GITPERLLIB="$GIT_EXEC_PATH"'/contrib/mw-to-git:'"$GITPERLLIB"
+PATH="$GIT_EXEC_PATH"'/contrib/mw-to-git:'"$PATH"
+
+export GITPERLLIB PATH
+
+exec "${GIT_EXEC_PATH}/bin-wrappers/git" "$@"
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread* [PATCH v7 4/7] git-remote-mediawiki: Update tests to run with the new bin-wrapper
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
` (2 preceding siblings ...)
2013-07-02 22:39 ` [PATCH v7 3/7] git-remote-mediawiki: New git bin-wrapper for developement benoit.person
@ 2013-07-02 22:39 ` benoit.person
2013-07-03 9:18 ` Matthieu Moy
2013-07-02 22:39 ` [PATCH v7 5/7] git-remote-mediawiki: Factoring code between git-remote-mediawiki and Git::Mediawiki benoit.person
` (2 subsequent siblings)
6 siblings, 1 reply; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
Until now, if git-remote-mediawiki was not installed, the test suite
copied it to the toplevel directory. This solution pollutes the
directory with untracked files. Plus, we would need to copy the new
git-mw.perl file to test it too.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
contrib/mw-to-git/t/test-gitmw-lib.sh | 8 ++------
1 file changed, 2 insertions(+), 6 deletions(-)
diff --git a/contrib/mw-to-git/t/test-gitmw-lib.sh b/contrib/mw-to-git/t/test-gitmw-lib.sh
index bb76cee..ca6860f 100755
--- a/contrib/mw-to-git/t/test-gitmw-lib.sh
+++ b/contrib/mw-to-git/t/test-gitmw-lib.sh
@@ -62,12 +62,8 @@ test_check_precond () {
test_done
fi
- if [ ! -f "$GIT_BUILD_DIR"/git-remote-mediawiki ];
- then
- echo "No remote mediawiki for git found. Copying it in git"
- echo "cp $GIT_BUILD_DIR/contrib/mw-to-git/git-remote-mediawiki $GIT_BUILD_DIR/"
- ln -s "$GIT_BUILD_DIR"/contrib/mw-to-git/git-remote-mediawiki "$GIT_BUILD_DIR"
- fi
+ GIT_EXEC_PATH=$(cd "$(dirname "$0")" && cd "../.." && pwd)
+ PATH="$GIT_EXEC_PATH"'/bin-wrapper:'"$PATH"
if [ ! -d "$WIKI_DIR_INST/$WIKI_DIR_NAME" ];
then
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread* Re: [PATCH v7 4/7] git-remote-mediawiki: Update tests to run with the new bin-wrapper
2013-07-02 22:39 ` [PATCH v7 4/7] git-remote-mediawiki: Update tests to run with the new bin-wrapper benoit.person
@ 2013-07-03 9:18 ` Matthieu Moy
0 siblings, 0 replies; 20+ messages in thread
From: Matthieu Moy @ 2013-07-03 9:18 UTC (permalink / raw)
To: benoit.person; +Cc: git, Celestin Matte, Junio C Hamano
benoit.person@ensimag.fr writes:
> --- a/contrib/mw-to-git/t/test-gitmw-lib.sh
> +++ b/contrib/mw-to-git/t/test-gitmw-lib.sh
> @@ -62,12 +62,8 @@ test_check_precond () {
> test_done
> fi
>
> - if [ ! -f "$GIT_BUILD_DIR"/git-remote-mediawiki ];
> - then
> - echo "No remote mediawiki for git found. Copying it in git"
> - echo "cp $GIT_BUILD_DIR/contrib/mw-to-git/git-remote-mediawiki $GIT_BUILD_DIR/"
> - ln -s "$GIT_BUILD_DIR"/contrib/mw-to-git/git-remote-mediawiki "$GIT_BUILD_DIR"
> - fi
> + GIT_EXEC_PATH=$(cd "$(dirname "$0")" && cd "../.." && pwd)
> + PATH="$GIT_EXEC_PATH"'/bin-wrapper:'"$PATH"
>
> if [ ! -d "$WIKI_DIR_INST/$WIKI_DIR_NAME" ];
> then
Cool!
I like the way adding a new feature has positive side effects on the
rest of the code.
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
^ permalink raw reply [flat|nested] 20+ messages in thread
* [PATCH v7 5/7] git-remote-mediawiki: Factoring code between git-remote-mediawiki and Git::Mediawiki
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
` (3 preceding siblings ...)
2013-07-02 22:39 ` [PATCH v7 4/7] git-remote-mediawiki: Update tests to run with the new bin-wrapper benoit.person
@ 2013-07-02 22:39 ` benoit.person
2013-07-02 22:39 ` [PATCH v7 6/7] git-remote-mediawiki: Adding git-mw command benoit.person
2013-07-02 22:39 ` [PATCH v7 7/7] git-remote-mediawiki: Add preview subcommand into git mw benoit.person
6 siblings, 0 replies; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
For now, Git::Mediawiki contains nothing.
This first patch moves some of git-remote-mediawiki.perl's factorisable code
into Git::Mediawiki. In the same time, it removes the side effects of that code
and renames the fucntions and constants moved to expose a better API.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
contrib/mw-to-git/Git/Mediawiki.pm | 77 +++++++++++++++++++++++++-
contrib/mw-to-git/git-remote-mediawiki.perl | 85 +++++------------------------
2 files changed, 89 insertions(+), 73 deletions(-)
diff --git a/contrib/mw-to-git/Git/Mediawiki.pm b/contrib/mw-to-git/Git/Mediawiki.pm
index 805f42a..47fe4f4 100644
--- a/contrib/mw-to-git/Git/Mediawiki.pm
+++ b/contrib/mw-to-git/Git/Mediawiki.pm
@@ -18,7 +18,82 @@ require Exporter;
@EXPORT = ();
# Methods which can be called as standalone functions as well:
-@EXPORT_OK = ();
+@EXPORT_OK = qw(clean_filename smudge_filename connect_maybe
+ EMPTY HTTP_CODE_OK);
+}
+
+# Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
+use constant SLASH_REPLACEMENT => '%2F';
+
+# Used to test for empty strings
+use constant EMPTY => q{};
+
+# HTTP codes
+use constant HTTP_CODE_OK => 200;
+
+sub clean_filename {
+ my $filename = shift;
+ $filename =~ s{@{[SLASH_REPLACEMENT]}}{/}g;
+ # [, ], |, {, and } are forbidden by MediaWiki, even URL-encoded.
+ # Do a variant of URL-encoding, i.e. looks like URL-encoding,
+ # but with _ added to prevent MediaWiki from thinking this is
+ # an actual special character.
+ $filename =~ s/[\[\]\{\}\|]/sprintf("_%%_%x", ord($&))/ge;
+ # If we use the uri escape before
+ # we should unescape here, before anything
+
+ return $filename;
+}
+
+sub smudge_filename {
+ my $filename = shift;
+ $filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
+ $filename =~ s/ /_/g;
+ # Decode forbidden characters encoded in clean_filename
+ $filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf('%c', hex($1))/ge;
+ return $filename;
+}
+
+sub connect_maybe {
+ my $wiki = shift;
+ if ($wiki) {
+ return $wiki;
+ }
+
+ my $remote_name = shift;
+ my $remote_url = shift;
+ my ($wiki_login, $wiki_password, $wiki_domain);
+
+ $wiki_login = Git::config("remote.${remote_name}.mwLogin");
+ $wiki_password = Git::config("remote.${remote_name}.mwPassword");
+ $wiki_domain = Git::config("remote.${remote_name}.mwDomain");
+
+ $wiki = MediaWiki::API->new;
+ $wiki->{config}->{api_url} = "${remote_url}/api.php";
+ if ($wiki_login) {
+ my %credential = (
+ 'url' => $remote_url,
+ 'username' => $wiki_login,
+ 'password' => $wiki_password
+ );
+ Git::credential(\%credential);
+ my $request = {lgname => $credential{username},
+ lgpassword => $credential{password},
+ lgdomain => $wiki_domain};
+ if ($wiki->login($request)) {
+ Git::credential(\%credential, 'approve');
+ print {*STDERR} qq(Logged in mediawiki user "$credential{username}".\n);
+ } else {
+ print {*STDERR} qq(Failed to log in mediawiki user "$credential{username}" on ${remote_url}\n);
+ print {*STDERR} ' (error ' .
+ $wiki->{error}->{code} . ': ' .
+ $wiki->{error}->{details} . ")\n";
+ Git::credential(\%credential, 'reject');
+ exit 1;
+ }
+ }
+
+ return $wiki;
}
1; # Famous last words
diff --git a/contrib/mw-to-git/git-remote-mediawiki.perl b/contrib/mw-to-git/git-remote-mediawiki.perl
index 71baf8a..e40c034 100755
--- a/contrib/mw-to-git/git-remote-mediawiki.perl
+++ b/contrib/mw-to-git/git-remote-mediawiki.perl
@@ -14,6 +14,8 @@
use strict;
use MediaWiki::API;
use Git;
+use Git::Mediawiki qw(clean_filename smudge_filename connect_maybe
+ EMPTY HTTP_CODE_OK);
use DateTime::Format::ISO8601;
use warnings;
@@ -23,9 +25,6 @@ binmode STDOUT, ':encoding(UTF-8)';
use URI::Escape;
-# Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
-use constant SLASH_REPLACEMENT => '%2F';
-
# It's not always possible to delete pages (may require some
# privileges). Deleted pages are replaced with this content.
use constant DELETED_CONTENT => "[[Category:Deleted]]\n";
@@ -40,8 +39,6 @@ use constant NULL_SHA1 => '0000000000000000000000000000000000000000';
# Used on Git's side to reflect empty edit messages on the wiki
use constant EMPTY_MESSAGE => '*Empty MediaWiki Message*';
-use constant EMPTY => q{};
-
# Number of pages taken into account at once in submodule get_mw_page_list
use constant SLICE_SIZE => 50;
@@ -50,8 +47,6 @@ use constant SLICE_SIZE => 50;
# the number of links to be returned (500 links max).
use constant BATCH_SIZE => 10;
-use constant HTTP_CODE_OK => 200;
-
if (@ARGV != 2) {
exit_error_usage();
}
@@ -199,37 +194,6 @@ sub parse_command {
# MediaWiki API instance, created lazily.
my $mediawiki;
-sub mw_connect_maybe {
- if ($mediawiki) {
- return;
- }
- $mediawiki = MediaWiki::API->new;
- $mediawiki->{config}->{api_url} = "${url}/api.php";
- if ($wiki_login) {
- my %credential = (
- 'url' => $url,
- 'username' => $wiki_login,
- 'password' => $wiki_passwd
- );
- Git::credential(\%credential);
- my $request = {lgname => $credential{username},
- lgpassword => $credential{password},
- lgdomain => $wiki_domain};
- if ($mediawiki->login($request)) {
- Git::credential(\%credential, 'approve');
- print {*STDERR} qq(Logged in mediawiki user "$credential{username}".\n);
- } else {
- print {*STDERR} qq(Failed to log in mediawiki user "$credential{username}" on ${url}\n);
- print {*STDERR} ' (error ' .
- $mediawiki->{error}->{code} . ': ' .
- $mediawiki->{error}->{details} . ")\n";
- Git::credential(\%credential, 'reject');
- exit 1;
- }
- }
- return;
-}
-
sub fatal_mw_error {
my $action = shift;
print STDERR "fatal: could not $action.\n";
@@ -339,7 +303,7 @@ sub get_mw_first_pages {
# Get the list of pages to be fetched according to configuration.
sub get_mw_pages {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
print {*STDERR} "Listing pages on remote wiki...\n";
@@ -529,7 +493,7 @@ sub get_last_local_revision {
# avoid a loop onto all tracked pages. This is useful for the fetch-by-rev
# option.
sub get_last_global_remote_rev {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
my $query = {
action => 'query',
@@ -545,7 +509,7 @@ sub get_last_global_remote_rev {
# Get the last remote revision concerning the tracked pages and the tracked
# categories.
sub get_last_remote_revision {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
my %pages_hash = get_mw_pages();
my @pages = values(%pages_hash);
@@ -601,29 +565,6 @@ sub mediawiki_smudge {
return "${string}\n";
}
-sub mediawiki_clean_filename {
- my $filename = shift;
- $filename =~ s{@{[SLASH_REPLACEMENT]}}{/}g;
- # [, ], |, {, and } are forbidden by MediaWiki, even URL-encoded.
- # Do a variant of URL-encoding, i.e. looks like URL-encoding,
- # but with _ added to prevent MediaWiki from thinking this is
- # an actual special character.
- $filename =~ s/[\[\]\{\}\|]/sprintf("_%%_%x", ord($&))/ge;
- # If we use the uri escape before
- # we should unescape here, before anything
-
- return $filename;
-}
-
-sub mediawiki_smudge_filename {
- my $filename = shift;
- $filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
- $filename =~ s/ /_/g;
- # Decode forbidden characters encoded in mediawiki_clean_filename
- $filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf('%c', hex($1))/ge;
- return $filename;
-}
-
sub literal_data {
my ($content) = @_;
print {*STDOUT} 'data ', bytes::length($content), "\n", $content;
@@ -831,7 +772,7 @@ sub mw_import_ref {
return;
}
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
print {*STDERR} "Searching revisions...\n";
my $last_local = get_last_local_revision();
@@ -945,7 +886,7 @@ sub mw_import_revids {
my %commit;
$commit{author} = $rev->{user} || 'Anonymous';
$commit{comment} = $rev->{comment} || EMPTY_MESSAGE;
- $commit{title} = mediawiki_smudge_filename($page_title);
+ $commit{title} = smudge_filename($page_title);
$commit{mw_revision} = $rev->{revid};
$commit{content} = mediawiki_smudge($rev->{'*'});
@@ -1006,7 +947,7 @@ sub mw_upload_file {
}
# Deleting and uploading a file requires a priviledged user
if ($file_deleted) {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
my $query = {
action => 'delete',
title => $path,
@@ -1022,7 +963,7 @@ sub mw_upload_file {
# Don't let perl try to interpret file content as UTF-8 => use "raw"
my $content = run_git("cat-file blob ${new_sha1}", 'raw');
if ($content ne EMPTY) {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
$mediawiki->{config}->{upload_url} =
"${url}/index.php/Special:Upload";
$mediawiki->edit({
@@ -1070,7 +1011,7 @@ sub mw_push_file {
my $old_sha1 = $diff_info_split[2];
my $page_created = ($old_sha1 eq NULL_SHA1);
my $page_deleted = ($new_sha1 eq NULL_SHA1);
- $complete_file_name = mediawiki_clean_filename($complete_file_name);
+ $complete_file_name = clean_filename($complete_file_name);
my ($title, $extension) = $complete_file_name =~ /^(.*)\.([^\.]*)$/;
if (!defined($extension)) {
@@ -1093,7 +1034,7 @@ sub mw_push_file {
$file_content = run_git("cat-file blob ${new_sha1}");
}
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
my $result = $mediawiki->edit( {
action => 'edit',
@@ -1279,7 +1220,7 @@ sub mw_push_revision {
}
sub get_allowed_file_extensions {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
my $query = {
action => 'query',
@@ -1303,7 +1244,7 @@ my %cached_mw_namespace_id;
# Return MediaWiki id for a canonical namespace name.
# Ex.: "File", "Project".
sub get_mw_namespace_id {
- mw_connect_maybe();
+ $mediawiki = connect_maybe($mediawiki, $remotename, $url);
my $name = shift;
if (!exists $namespace_id{$name}) {
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread* [PATCH v7 6/7] git-remote-mediawiki: Adding git-mw command
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
` (4 preceding siblings ...)
2013-07-02 22:39 ` [PATCH v7 5/7] git-remote-mediawiki: Factoring code between git-remote-mediawiki and Git::Mediawiki benoit.person
@ 2013-07-02 22:39 ` benoit.person
2013-07-02 22:39 ` [PATCH v7 7/7] git-remote-mediawiki: Add preview subcommand into git mw benoit.person
6 siblings, 0 replies; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
For now, git-remote-mediawiki is only a remote-helper. This patch adds a new
toolset script in which we will be able to build new tools for
git-remote-mediawiki.
This toolset uses a subcommand-mechanism to launch the proper action. For now
only the 'help' subcommand is implemented. It also provides some generic code
for the verbose and help command line options.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
contrib/mw-to-git/Makefile | 7 ++---
contrib/mw-to-git/git-mw.perl | 60 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 64 insertions(+), 3 deletions(-)
create mode 100755 contrib/mw-to-git/git-mw.perl
diff --git a/contrib/mw-to-git/Makefile b/contrib/mw-to-git/Makefile
index c5e66df..775cb07 100644
--- a/contrib/mw-to-git/Makefile
+++ b/contrib/mw-to-git/Makefile
@@ -14,6 +14,7 @@
GIT_MEDIAWIKI_PM=Git/Mediawiki.pm
SCRIPT_PERL=git-remote-mediawiki.perl
+SCRIPT_PERL+=git-mw.perl
GIT_ROOT_DIR=../..
HERE=contrib/mw-to-git/
@@ -27,15 +28,15 @@ install_pm:
install $(GIT_MEDIAWIKI_PM) $(INSTLIBDIR)/$(GIT_MEDIAWIKI_PM)
build:
- $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL=$(SCRIPT_PERL_FULL) \
+ $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL="$(SCRIPT_PERL_FULL)" \
build-perl-script
install: install_pm
- $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL=$(SCRIPT_PERL_FULL) \
+ $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL="$(SCRIPT_PERL_FULL)" \
install-perl-script
clean:
- $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL=$(SCRIPT_PERL_FULL) \
+ $(MAKE) -C $(GIT_ROOT_DIR) SCRIPT_PERL="$(SCRIPT_PERL_FULL)" \
clean-perl-script
rm $(INSTLIBDIR)/$(GIT_MEDIAWIKI_PM)
diff --git a/contrib/mw-to-git/git-mw.perl b/contrib/mw-to-git/git-mw.perl
new file mode 100755
index 0000000..4a3e4a9
--- /dev/null
+++ b/contrib/mw-to-git/git-mw.perl
@@ -0,0 +1,60 @@
+#!/usr/bin/perl
+
+# Copyright (C) 2013
+# Benoit Person <benoit.person@ensimag.imag.fr>
+# Celestin Matte <celestin.matte@ensimag.imag.fr>
+# License: GPL v2 or later
+
+# Set of tools for git repo with a mediawiki remote.
+# Documentation & bugtracker: https://github.com/moy/Git-Mediawiki/
+
+use strict;
+use warnings;
+
+use Getopt::Long;
+
+# By default, use UTF-8 to communicate with Git and the user
+binmode STDERR, ':encoding(UTF-8)';
+binmode STDOUT, ':encoding(UTF-8)';
+
+# Global parameters
+my $verbose = 0;
+sub v_print {
+ if ($verbose) {
+ return print {*STDERR} @_;
+ }
+ return;
+}
+
+my %commands = (
+ 'help' =>
+ [\&help, {}, \&help]
+);
+
+# Search for sub-command
+my $cmd = $commands{'help'};
+for (0..@ARGV-1) {
+ if (defined $commands{$ARGV[$_]}) {
+ $cmd = $commands{$ARGV[$_]};
+ splice @ARGV, $_, 1;
+ last;
+ }
+};
+GetOptions( %{$cmd->[1]},
+ 'help|h' => \&{$cmd->[2]},
+ 'verbose|v' => \$verbose);
+
+# Launch command
+&{$cmd->[0]};
+
+############################## Help Functions ##################################
+
+sub help {
+ print {*STDOUT} <<'END';
+usage: git mw <command> <args>
+
+git mw commands are:
+ help Display help information about git mw
+END
+ exit;
+}
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread* [PATCH v7 7/7] git-remote-mediawiki: Add preview subcommand into git mw
2013-07-02 22:39 [PATCH v7 0/7] git-remote-mediawiki: new tool to preview local changes without pushing benoit.person
` (5 preceding siblings ...)
2013-07-02 22:39 ` [PATCH v7 6/7] git-remote-mediawiki: Adding git-mw command benoit.person
@ 2013-07-02 22:39 ` benoit.person
6 siblings, 0 replies; 20+ messages in thread
From: benoit.person @ 2013-07-02 22:39 UTC (permalink / raw)
To: git; +Cc: Celestin Matte, Matthieu Moy, Junio C Hamano, Benoit Person
From: Benoit Person <benoit.person@ensimag.fr>
In the current state, a user of git-remote-mediawiki can edit the markup text
locally, but has to push to the remote wiki to see how the page is rendererd.
Add a new 'git mw preview' command that allows rendering the markup text on
the remote wiki without actually pushing any change on the wiki.
This uses Mediawiki's API to render the markup and inserts it in an actual
HTML page from the wiki so that CSS can be rendered properly. Most links
should work when the page exists on the remote.
Signed-off-by: Benoit Person <benoit.person@ensimag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
---
contrib/mw-to-git/Git/Mediawiki.pm | 3 +-
contrib/mw-to-git/git-mw.perl | 310 ++++++++++++++++++++++++++++++++++++-
2 files changed, 311 insertions(+), 2 deletions(-)
diff --git a/contrib/mw-to-git/Git/Mediawiki.pm b/contrib/mw-to-git/Git/Mediawiki.pm
index 47fe4f4..d13c4df 100644
--- a/contrib/mw-to-git/Git/Mediawiki.pm
+++ b/contrib/mw-to-git/Git/Mediawiki.pm
@@ -19,7 +19,7 @@ require Exporter;
# Methods which can be called as standalone functions as well:
@EXPORT_OK = qw(clean_filename smudge_filename connect_maybe
- EMPTY HTTP_CODE_OK);
+ EMPTY HTTP_CODE_OK HTTP_CODE_PAGE_NOT_FOUND);
}
# Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
@@ -30,6 +30,7 @@ use constant EMPTY => q{};
# HTTP codes
use constant HTTP_CODE_OK => 200;
+use constant HTTP_CODE_PAGE_NOT_FOUND => 404;
sub clean_filename {
my $filename = shift;
diff --git a/contrib/mw-to-git/git-mw.perl b/contrib/mw-to-git/git-mw.perl
index 4a3e4a9..28df3ee 100755
--- a/contrib/mw-to-git/git-mw.perl
+++ b/contrib/mw-to-git/git-mw.perl
@@ -12,6 +12,14 @@ use strict;
use warnings;
use Getopt::Long;
+use URI::URL qw(url);
+use LWP::UserAgent;
+use HTML::TreeBuilder;
+
+use Git;
+use MediaWiki::API;
+use Git::Mediawiki qw(clean_filename connect_maybe
+ EMPTY HTTP_CODE_PAGE_NOT_FOUND);
# By default, use UTF-8 to communicate with Git and the user
binmode STDERR, ':encoding(UTF-8)';
@@ -26,9 +34,26 @@ sub v_print {
return;
}
+# Preview parameters
+my $file_name = EMPTY;
+my $remote_name = EMPTY;
+my $preview_file_name = EMPTY;
+my $autoload = 0;
+sub file {
+ $file_name = shift;
+ return $file_name;
+}
+
my %commands = (
'help' =>
- [\&help, {}, \&help]
+ [\&help, {}, \&help],
+ 'preview' =>
+ [\&preview, {
+ '<>' => \&file,
+ 'output|o=s' => \$preview_file_name,
+ 'remote|r=s' => \$remote_name,
+ 'autoload|a' => \$autoload
+ }, \&preview_help]
);
# Search for sub-command
@@ -47,6 +72,288 @@ GetOptions( %{$cmd->[1]},
# Launch command
&{$cmd->[0]};
+############################# Preview Functions ################################
+
+sub preview_help {
+ print {*STDOUT} <<'END';
+USAGE: git mw preview [--remote|-r <remote name>] [--autoload|-a]
+ [--output|-o <output filename>] [--verbose|-v]
+ <blob> | <filename>
+
+DESCRIPTION:
+Preview is an utiliy to preview local content of a mediawiki repo as if it was
+pushed on the remote.
+
+For that, preview searches for the remote name of the current branch's
+upstream if --remote is not set. If that remote is not found or if it
+is not a mediawiki, it lists all mediawiki remotes configured and asks
+you to replay your command with the --remote option set properly.
+
+Then, it searches for a file named 'filename'. If it's not found in
+the current dir, it will assume it's a blob.
+
+The content retrieved in the file (or in the blob) will then be parsed
+by the remote mediawiki and combined with a template retrieved from
+the mediawiki.
+
+Finally, preview will save the HTML result in a file. and autoload it
+in your default web browser if the option --autoload is present.
+
+OPTIONS:
+ -r <remote name>, --remote <remote name>
+ If the remote is a mediawiki, the template and the parse engine
+ used for the preview will be those of that remote.
+ If not, a list of valid remotes will be shown.
+
+ -a, --autoload
+ Try to load the HTML output in a new tab (or new window) of your
+ default web browser.
+
+ -o <output filename>, --output <output filename>
+ Change the HTML output filename. Default filename is based on the
+ input filename with its extension replaced by '.html'.
+
+ -v, --verbose
+ Show more information on what's going on under the hood.
+END
+ exit;
+}
+
+sub preview {
+ my $wiki;
+ my ($remote_url, $wiki_page_name);
+ my ($new_content, $template);
+ my $file_content;
+
+ if ($file_name eq EMPTY) {
+ die "Missing file argument, see `git mw help`\n";
+ }
+
+ v_print("### Selecting remote\n");
+ if ($remote_name eq EMPTY) {
+ $remote_name = find_upstream_remote_name();
+ if ($remote_name) {
+ $remote_url = mediawiki_remote_url_maybe($remote_name);
+ }
+
+ if (! $remote_url) {
+ my @valid_remotes = find_mediawiki_remotes();
+
+ if ($#valid_remotes == 0) {
+ print {*STDERR} "No mediawiki remote in this repo. \n";
+ exit 1;
+ } else {
+ my $remotes_list = join("\n\t", @valid_remotes);
+ print {*STDERR} <<"MESSAGE";
+There are multiple mediawiki remotes, which of:
+ ${remotes_list}
+do you want ? Use the -r option to specify the remote.
+MESSAGE
+ }
+
+ exit 1;
+ }
+ } else {
+ if (!is_valid_remote($remote_name)) {
+ die "${remote_name} is not a remote\n";
+ }
+
+ $remote_url = mediawiki_remote_url_maybe($remote_name);
+ if (! $remote_url) {
+ die "${remote_name} is not a mediawiki remote\n";
+ }
+ }
+ v_print("selected remote:\n\tname: ${remote_name}\n\turl: ${remote_url}\n");
+
+ $wiki = connect_maybe($wiki, $remote_name, $remote_url);
+
+ # Read file content
+ if (! -e $file_name) {
+ $file_content = git_cmd_try {
+ Git::command('cat-file', 'blob', $file_name); }
+ "%s failed w/ code %d";
+
+ if ($file_name =~ /(.+):(.+)/) {
+ $file_name = $2;
+ }
+ } else {
+ open my $read_fh, "<", $file_name
+ or die "could not open ${file_name}: $!\n";
+ $file_content = do { local $/ = undef; <$read_fh> };
+ close $read_fh
+ or die "unable to close: $!\n";
+ }
+
+ v_print("### Retrieving template\n");
+ ($wiki_page_name = clean_filename($file_name)) =~ s/\.[^.]+$//;
+ $template = get_template($remote_url, $wiki_page_name);
+
+ v_print("### Parsing local content\n");
+ $new_content = $wiki->api({
+ action => 'parse',
+ text => $file_content,
+ title => $wiki_page_name
+ }, {
+ skip_encoding => 1
+ }) or die "No response from remote mediawiki\n";
+ $new_content = $new_content->{'parse'}->{'text'}->{'*'};
+
+ v_print("### Merging contents\n");
+ if ($preview_file_name eq EMPTY) {
+ ($preview_file_name = $file_name) =~ s/\.[^.]+$/.html/;
+ }
+ open(my $save_fh, '>:encoding(UTF-8)', $preview_file_name)
+ or die "Could not open: $!\n";
+ print {$save_fh} merge_contents($template, $new_content, $remote_url);
+ close($save_fh)
+ or die "Could not close: $!\n";
+
+ v_print("### Results\n");
+ if ($autoload) {
+ v_print("Launching browser w/ file: ${preview_file_name}");
+ system('git', 'web--browse', $preview_file_name);
+ } else {
+ print {*STDERR} "Preview file saved as: ${preview_file_name}\n";
+ }
+
+ exit;
+}
+
+# uses global scope variable: $remote_name
+sub merge_contents {
+ my $template = shift;
+ my $content = shift;
+ my $remote_url = shift;
+ my ($content_tree, $html_tree, $mw_content_text);
+ my $template_content_id = 'bodyContent';
+
+ $html_tree = HTML::TreeBuilder->new;
+ $html_tree->parse($template);
+
+ $content_tree = HTML::TreeBuilder->new;
+ $content_tree->parse($content);
+
+ $template_content_id = Git::config("remote.${remote_name}.mwIDcontent")
+ || $template_content_id;
+ v_print("Using '${template_content_id}' as the content ID\n");
+
+ $mw_content_text = $html_tree->look_down('id', $template_content_id);
+ if (!defined $mw_content_text) {
+ print {*STDERR} <<"CONFIG";
+Could not combine the new content with the template. You might want to
+configure `mediawiki.IDContent` in your config:
+ git config --add remote.${remote_name}.mwIDcontent <id>
+and re-run the command afterward.
+CONFIG
+ exit 1;
+ }
+ $mw_content_text->delete_content();
+ $mw_content_text->push_content($content_tree);
+
+ make_links_absolute($html_tree, $remote_url);
+
+ return $html_tree->as_HTML;
+}
+
+sub make_links_absolute {
+ my $html_tree = shift;
+ my $remote_url = shift;
+ for (@{ $html_tree->extract_links() }) {
+ my ($link, $element, $attr) = @{ $_ };
+ my $url = url($link)->canonical;
+ if ($url !~ /#/) {
+ $element->attr($attr, URI->new_abs($url, $remote_url));
+ }
+ }
+ return $html_tree;
+}
+
+sub is_valid_remote {
+ my $remote = shift;
+ my @remotes = git_cmd_try {
+ Git::command('remote') }
+ "%s failed w/ code %d";
+ my $found_remote = 0;
+ foreach my $remote (@remotes) {
+ if ($remote eq $remote) {
+ $found_remote = 1;
+ last;
+ }
+ }
+ return $found_remote;
+}
+
+sub find_mediawiki_remotes {
+ my @remotes = git_cmd_try {
+ Git::command('remote'); }
+ "%s failed w/ code %d";
+ my $remote_url;
+ my @valid_remotes = ();
+ foreach my $remote (@remotes) {
+ $remote_url = mediawiki_remote_url_maybe($remote);
+ if ($remote_url) {
+ push(@valid_remotes, $remote);
+ }
+ }
+ return @valid_remotes;
+}
+
+sub find_upstream_remote_name {
+ my $current_branch = git_cmd_try {
+ Git::command_oneline('symbolic-ref', '--short', 'HEAD') }
+ "%s failed w/ code %d";
+ return Git::config("branch.${current_branch}.remote");
+}
+
+sub mediawiki_remote_url_maybe {
+ my $remote = shift;
+
+ # Find remote url
+ my $remote_url = Git::config("remote.${remote}.url");
+ if ($remote_url =~ s/mediawiki::(.*)/$1/) {
+ return url($remote_url)->canonical;
+ }
+
+ return;
+}
+
+sub get_template {
+ my $url = shift;
+ my $page_name = shift;
+ my ($req, $res, $code, $url_after);
+
+ $req = LWP::UserAgent->new;
+ if ($verbose) {
+ $req->show_progress(1);
+ }
+
+ $res = $req->get("${url}/index.php?title=${page_name}");
+ if (!$res->is_success) {
+ $code = $res->code;
+ $url_after = $res->request()->uri(); # resolve all redirections
+ if ($code == HTTP_CODE_PAGE_NOT_FOUND) {
+ if ($verbose) {
+ print {*STDERR} <<"WARNING";
+Warning: Failed to retrieve '$page_name'. Create it on the mediawiki if you want
+all the links to work properly.
+Trying to use the mediawiki homepage as a fallback template ...
+WARNING
+ }
+
+ # LWP automatically redirects GET request
+ $res = $req->get("${url}/index.php");
+ if (!$res->is_success) {
+ $url_after = $res->request()->uri(); # resolve all redirections
+ die "Failed to get homepage @ ${url_after} w/ code ${code}\n";
+ }
+ } else {
+ die "Failed to get '${page_name}' @ ${url_after} w/ code ${code}\n";
+ }
+ }
+
+ return $res->decoded_content;
+}
+
############################## Help Functions ##################################
sub help {
@@ -55,6 +362,7 @@ usage: git mw <command> <args>
git mw commands are:
help Display help information about git mw
+ preview Parse and render local file into HTML
END
exit;
}
--
1.8.3.1.590.gc07d91b
^ permalink raw reply related [flat|nested] 20+ messages in thread