infoCenter/app/createInfoCenter.sh

#!/usr/bin/env bash

#*******************************************************************************
# Copyright (c) 2019 Eclipse Foundation and others.
# This program and the accompanying materials are made available
# under the terms of the Eclipse Public License 2.0
# which is available at http://www.eclipse.org/legal/epl-v20.html,
# or the MIT License which is available at https://opensource.org/licenses/MIT.
# SPDX-License-Identifier: EPL-2.0 OR MIT
#*******************************************************************************

# This script requires the following files to be present in the same dir:
# * plugin_customization.ini

# Bash strict-mode
set -o errexit
#set -o nounset #FIXME
set -o pipefail

# Parameters:
# $1 = release name (e.g. 2019-09, 2019-12)
# $2 = subdir to platform zip (e.g. R-4.17-202009021800)
release_name=${1:-}
subdir=${2:-}
p2_repo_dir=${3:-}
past_release=${4:-'false'}

#help_home=/home/data/httpd/help.eclipse.org/
help_home=.
workdir=${help_home}/${release_name}
platform_dir=/home/data/httpd/download.eclipse.org/eclipse/downloads/drops4
p2_base_dir=/home/data/httpd/download.eclipse.org
script_name="$(basename ${0})"

ssh_remote="genie.simrel@projects-storage.eclipse.org"

info_center_port=8086

usage() {
  printf "Usage %s [releaseName] [pathToArchive] [p2RepoDir] [pastRelease]\n" "${script_name}"
  printf "\t%-16s the release name (e.g. 2020-12, 2021-03, etc)\n" "releaseName"
  printf "\t%-16s the subdir to eclipse-platform archive (e.g. R-4.17-202009021800)\n" "subDir"
  printf "\t%-16s the path to the P2 repo (e.g. releases/2020-12/202012161000) (optional)\n" "p2RepoDir"
  printf "\t%-16s set to 'true' to change banner to say 'Past release' (default is 'false') (optional)\n" "pastRelease"
}

# Verify inputs
if [[ -z "${release_name}" && $# -lt 1 ]]; then
  printf "ERROR: a release name must be given.\n"
  usage
  exit 1
fi

if [[ -z "${subdir}" && $# -lt 2 ]]; then
  printf "ERROR: a subdir the eclipse-platform archive must be given.\n"
  usage
  exit 1
fi

prepare() {
  # Create new sub directory for info center
  echo "Create sub directory for new info center ${release_name}..."
  mkdir -p ${workdir}

  # TODO: exit when sub directory already exists?

  # Copy/download eclipse-platform
  echo "Downloading eclipse-platform..."
  if [ ! -f eclipse-platform*.tar.gz ]; then
    scp "${ssh_remote}:/${platform_dir}/${subdir}/eclipse-platform-*-linux-gtk-x86_64.tar.gz" .
  fi

  # Extract eclipse-platform
  tar xzf eclipse-platform*.tar.gz -C ${workdir}

  # Copy eclipse/plugin_customization.ini
  echo "Copying plugin_customization.ini..."
  cp plugin_customization.ini ${workdir}/eclipse/

  # Create dropins/plugins dir
  echo "Create dropins/plugins dir..."
  mkdir -p ${workdir}/eclipse/dropins/plugins
}

find_base() {
  local workdir=${1:-}
  # Find org.eclipse.help.base
  help_base_path=$(find ${workdir} -name "org.eclipse.help.base*.jar")
  #TODO: deal with potential errors
  substring_tmp=${help_base_path#.*_}
  help_base_version=${substring_tmp%.jar}
  echo ${help_base_version}
}

find_doc_jars() {
  local p2_repo_dir="${p2_base_dir}/${p2_repo_dir}"
  local plugins_file="doc_plugins.tar"
  local remote_shell_script="find_doc_jars.sh"

  echo "Find doc JARs..."

  printf "  Looking up all JAR files that contain the string 'org.eclipse.help.toc'...\n"
  printf "  Using the following P2 repository: ${p2_repo_dir} \n"

  cat << 'EOF' > ${remote_shell_script}
#!/usr/bin/env bash

set -o errexit
set -o nounset
set -o pipefail

p2_repo_dir=${1:-}
jar_list=$(find "${p2_repo_dir}/plugins" -name '*.jar' ! -name '*source*' -printf '%f\n')
output_file="doc_plugins.tar"

rm -f ${output_file}*

for file in ${jar_list}
do
  if ( unzip -p "${p2_repo_dir}/plugins/${file}" plugin.xml 2>&1 | grep -q "org.eclipse.help.toc" ); then
    tar rvf "${output_file}" -C "${p2_repo_dir}/plugins" "${file}"
  fi
done
EOF

  scp ${remote_shell_script} "${ssh_remote}:~/"
  rm ${remote_shell_script} #remove local copy
  ssh ${ssh_remote} "chmod +x ${remote_shell_script}; ./${remote_shell_script} ${p2_repo_dir}"
  scp "${ssh_remote}:${plugins_file}" .
  tar xf "${plugins_file}" -C "${workdir}/eclipse/dropins/plugins/"
  no_of_files=$(find "${workdir}/eclipse/dropins/plugins/" -name *.jar | wc -l)
  printf "  Found ${no_of_files} JAR files.\n" 
}

create_banner() {
  local version=$1
  local banner_jar=org.foundation.helpbanner2_2.0.0.jar
  local banner_dir=./banner
  local banner_path=${banner_dir}/banner.html

  local token="Eclipse Oxygen"

  printf "Creating banner...\n"

  cp ${banner_path} ${banner_dir}/../banner.html.bak

  # replace version
  sed -i "s/${token}/Eclipse IDE ${version}/g" ${banner_path}

  if [[ ${past_release} == 'true' ]]; then
    sed -i "s/Current Release/Past Release/g" ${banner_path}
    # add text  
    sed -i '/<div class="right">/i   <div class="center">\n    <h3>Please note, this is an outdated version of the Eclipse IDE documentation.<br \/>\n    For the latest version, please visit: <a href="https://help.eclipse.org/latest/" target="_parent">https://help.eclipse.org/latest/</a>\n    </h3>\n  </div>' ${banner_path}
  fi

  # create jar
  pushd ${banner_dir} > /dev/null
  zip -rq ../${banner_jar} .
  popd > /dev/null

  # reset banner.html
  cp ${banner_dir}/../banner.html.bak ${banner_path}
  rm ${banner_dir}/../banner.html.bak

  # Add custom banner
  echo "Adding custom banner..."
  cp ${banner_jar} ${workdir}/eclipse/dropins/plugins/${banner_jar}
}

create_scripts() {
  local workdir=${1:-}
  local help_base_version=${2:-}
  local info_center_port=${3:-}
  # Create start script
  echo "Create start and stop scripts..."
  cat <<EOF > ${workdir}/startInfoCenter.sh
#!/usr/bin/env bash
port=${info_center_port}
java -Dhelp.lucene.tokenizer=standard -Dorg.eclipse.equinox.http.jetty.context.sessioninactiveinterval=60 -classpath eclipse/plugins/org.eclipse.help.base_${help_base_version}.jar org.eclipse.help.standalone.Infocenter -clean -command start -eclipsehome eclipse -port \${port} -nl en -locales en -plugincustomization plugin_customization.ini -vmargs -Xmx1024m -XX:+HeapDumpOnOutOfMemoryError &
echo "The Eclipse info center is now started and can be accessed here: http://localhost:\${port}/help/index.jsp"
EOF

  # Create stop script
  cat <<EOG > ${workdir}/stopInfoCenter.sh
#!/usr/bin/env bash
port=${info_center_port}
java -classpath eclipse/plugins/org.eclipse.help.base_${help_base_version}.jar org.eclipse.help.standalone.Infocenter -clean -command shutdown -eclipsehome eclipse -port \${port} 2>&1
echo "The Eclipse info center is now stopped."
EOG

  chmod +x ${workdir}/*InfoCenter.sh
}

create_archive() {
  local workdir=${1:-}
  local release_name=${2:-}
  # Create tar.gz
  # if [ -f info-center-${release_name}.tar.gz ]; then
  #   rm info-center-${release_name}.tar.gz
  # fi
  echo "Creating info center archive..."
  full_date=$(date +%Y-%m-%d-%H-%M-%S)
  tar czf info-center-${release_name}-${full_date}.tar.gz ${workdir}
}

prepare
help_base_version=$(find_base ${workdir})
echo "Found base version ${help_base_version}."
find_doc_jars
create_banner ${release_name} ${workdir}
create_scripts ${workdir} ${help_base_version} ${info_center_port}
create_archive ${workdir} ${release_name}

printf "Done.\n"