JPlag - Detecting Source Code Plagiarism

Supported Languages

Download and Installation

Downloading a release

Via Maven

<dependency>  <groupId>de.jplag</groupId>  <artifactId>jplag</artifactId>  <version><!--desired version--></version></dependency>

Building from sources

Usage

CLI

Parameter descriptions:       [root-dirs[,root-dirs...]...]                        Root-directory with submissions to check for                          plagiarism. If mode is set to VIEW, this parameter                          can be used to specify a report file to open. In that                          case only a single file may be specified.      -bc, --bc, --base-code=<baseCode>                        Path to the base code directory (common framework used                          in all submissions).      -l, --language=<language>                        Select the language of the submissions (default: java).                          See subcommands below.      -M, --mode=<{RUN, VIEW, RUN_AND_VIEW, AUTO}>                        The mode of JPlag. One of: RUN, VIEW, RUN_AND_VIEW,                          AUTO (default: null). If VIEW is chosen, you can                          optionally specify a path to an existing report.      -n, --shown-comparisons=<shownComparisons>                        The maximum number of comparisons that will be shown in                          the generated report, if set to -1 all comparisons                          will be shown (default: 2500)      -new, --new=<newDirectories>[,<newDirectories>...]                        Root-directories with submissions to check for                          plagiarism (same as root).      --normalize       Activate the normalization of tokens. Supported for                          languages: Java, C++.      -old, --old=<oldDirectories>[,<oldDirectories>...]                        Root-directories with prior submissions to compare                          against.      -r, --result-file=<resultFile>                        Name of the file in which the comparison results will                          be stored (default: results). Missing .zip endings                          will be automatically added.      -t, --min-tokens=<minTokenMatch>                        Tunes the comparison sensitivity by adjusting the                          minimum token required to be counted as a matching                          section. A smaller value increases the sensitivity                          but might lead to more false-positives.Advanced      --csv-export      Export pairwise similarity values as a CSV file.      -d, --debug           Store on-parsable files in error folder.      --log-level=<{ERROR, WARN, INFO, DEBUG, TRACE}>                        Set the log level for the cli.      -m, --similarity-threshold=<similarityThreshold>                        Comparison similarity threshold [0.0-1.0]: All                          comparisons above this threshold will be saved                          (default: 0.0).      --overwrite       Existing result files will be overwritten.      -p, --suffixes=<suffixes>[,<suffixes>...]                        comma-separated list of all filename suffixes that are                          included.      -P, --port=<port>     The port used for the internal report viewer (default:                          1996).      -s, --subdirectory=<subdirectory>                        Look in directories <root-dir>/*/<dir> for programs.      -x, --exclusion-file=<exclusionFileName>                        All files named in this file will be ignored in the                          comparison (line-separated list).Clustering      --cluster-alg, --cluster-algorithm=<{AGGLOMERATIVE, SPECTRAL}>                        Specifies the clustering algorithm. Available                          algorithms: agglomerative, spectral (default:                          spectral).      --cluster-metric=<{AVG, MIN, MAX, INTERSECTION}>                        The similarity metric used for clustering. Available                          metrics: average similarity, minimum similarity,                          maximal similarity, matched tokens (default: average                          similarity).      --cluster-skip    Skips the cluster calculation.Subsequence Match Merging      --gap-size=<maximumGapSize>                        Maximal gap between neighboring matches to be merged                          (between 1 and minTokenMatch, default: 6).      --match-merging   Enables merging of neighboring matches to counteract                          obfuscation attempts.      --neighbor-length=<minimumNeighborLength>                        Minimal length of neighboring matches to be merged                          (between 1 and minTokenMatch, default: 2).      --required-merges=<minimumRequiredMerges>                        Minimal required merges for the merging to be applied                          (between 1 and 50, default: 6).Languages:  c  cpp  csharp  emf  emf-model  go  java  javascript  kotlin  llvmir  multi  python3  rlang  rust  scheme  scxml  swift  text  typescript

Java API

Languagelanguage =newJavaLanguage();Set<File>submissionDirectories =Set.of(newFile("/path/to/rootDir"));FilebaseCode =newFile("/path/to/baseCode");JPlagOptionsoptions =newJPlagOptions(language,submissionDirectories,Set.of()).withBaseCodeSubmissionDirectory(baseCode);try {JPlagResultresult =JPlag.run(options);// OptionalReportObjectFactoryreportObjectFactory =newReportObjectFactory(newFile("/path/to/output"));reportObjectFactory.createAndSaveReport(result);}catch (ExitExceptione) {// error handling here}catch (FileNotFoundExceptione) {// handle IO exception here}

Contributing

Contact

More information can be found in ourWiki!