02
Sat, Nov
2 New Articles

The Best of Cozzi: "Web Browser Output with RPG IV and CGI"

RPG
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Editor's Note: Bob Cozzi is on vacation, so in this issue, we offer two of Bob's most popular past articles.

In the last issue, I started introducing you to the world of Common Gateway Interface (CGI) programming. CGI gives you the ability to communicate with a Web browser. My focus in this series of articles is to use RPG IV with CGI to allow you to create great applications with a browser-type interface.

To read data from the Web browser, either you call the QtmhGetEnv API to request the QUERY_STRING value or you read from standard input (stdin) by calling the QtmhRdStin API.

For CGI programs of any size, most CGI programmers use a CGI library to avoid programming the complicated details normally required by the CGI process. According to the Reader Poll in the last issue, most of you are not programming in CGI yet. But of those who are, the largest group is using a CGI add-on library (i.e., service program). The second largest group is using some of the cool third-party tools that generate Web-enabled programs. And virtually none of you are using the raw/native CGI APIs. This is good news! So this week, I want to show you how to write data back out to the Web browser. I will illustrate how to do some of that using the low-level CGI APIs and how to do it using one of the add-on libraries.

RPG for the Web

Using RPG to write data to the Web isn't all that tough. What is tough is learning all the ins and outs of this new environment. Let me start by giving you one of the most important clues about writing HTML to the Web: You have to tell the browser what you are going to send it before you actually send anything, or you could end up with an empty browser window.

Before sending data to the browser, you must send a CGI header. The term "header" is not unlike a report heading in that it appears first. This CGI header tells the browser to get ready to receive something. The "something" is identified in the header itself. You send the browser a CGI header followed by HTML. If you do not send the header, unpredictable results may occur.

To tell the browser that your RPG program is about to send it a bunch of HTML, you would send the following:

Content-type: text/html

The so-called "content type" header tells the browser what to expect. It is to except, in this case, HTML in the form of plain text.

There are two other CGI headers: One allows you to tell the browser to open up an existing Web page, while the other allows you to tell the browser to display an error page.

CGI headers are terminated with a "line feed" symbol. This is required; otherwise, the header will not be recognized. In addition, a CGI header must be followed by an "empty line." In CGI terms, an "empty line" doesn't mean a blank line, but rather a second line feed character that immediately follows the first one.

In most languages, the symbol is used to represent a line feed character. So the content-type header would be represented as follows:

Content-type: text/html

Note the two line feed symbols immediately after the CGI header. This indicates the end of the CGI header so that the browser knows there's no more header stuff coming. Unfortunately, RPG IV doesn't understand symbols the way C, C++, and Java do. In fact, you have to insert the EBCDIC equivalent of the ASCII line feed characters yourself. Originally, IBM misidentified the EBCDIC character that is translated into a line feed symbol in ASCII. Now, it is well-known that X'25' is the proper symbol to use for this purpose.

Once you've sent the content type header to the browser, you can start writing HTML. Use the QtmhWrStout API to write data to the browser. Include the CGI header unless you have a subprocedure wrapper that simplifies the call to the API.

The code in Figure 1 sends the content-type header and the two required line feed characters to the browser:

     D stdout          PR                  ExtProc('QtmhWrStout')
     D  szHtml                    65535A   Const OPTIONS(*VARSIZE)
     D  nBufLen                      10I 0 CONST
     D  api_error                    16A   OPTIONS(*VARSIZE)

     D cgiHeader       C                   Const('Content-Type: text/html')
     D LF              C                   Const(X'25')
     D apiError        S             16A   Inz(*ALLX'00') 

     C                   callp     StdOut(cgiHeader + LF + LF : 
     C                                    %size(cgiHeader) + 2 : apiError

Figure 1: Write the CGI header.

The named constant LF (line feed) represents the in RPG IV (i.e., the X'25' character). The X'25' is translated to ASCII automatically.

Calling the QtmhWrStout API via the prototype STDOUT with the CALLP operation sends the CGI header to the browser. At this point, the browser is ready to receive subsequent stuff.

Unlike the QtmhRdStin API, the QtmhWrStout API may be called as many times as necessary to complete the HTML output process. So don't worry about trying to save the entire HTML in one large field before writing out to the browser.

Writing HTML to the Browser

Once you've sent the CGI header, you can start sending HTML. The question that you must answer now is "Where do I get the HTML?"

HTML is text, so it can be either stored in source members or IFS files, or embedded in the RPG IV calc specs or compile-time arrays. It's really up to you.

The structure of a Web page's HTML is important. HTML files are referred to as "HTML documents." HTML documents have a formal structure that includes a header and a body. The HTML header area contains the Web page's title and any scripts you're providing. The HTML body contains everything you see in the browser window.

I won't get into too much detail about HTML. There are, after all, thousands of books, as well as the www.w3c.org and www.htmlhelp.com Web sites, that can teach you everything about HTML you'd ever want to know.

The HTML source member named INDEX in QHTMLSRC is illustrated below.



My First Webpage





Hello World! 


Nice to see you.



To write this HTML out to the Web browser, create a simple read/write RPG IV program. The program will simply open the HTML source member, read a source line, and then write it out to the Web browser by calling the QtmhWrStout API. This technique is illustrated in Figure 2.

     H DFTACTGRP(*NO) BNDDIR('CGI')
      ****************************************************************
      ** PGM: READHTML - Read HTML Source and write it to the browser.
      ****************************************************************
     FQHTMLSRC  IF   E             DISK    EXTMBR('INDEX')
     F                                     Rename(QHTMLSRC : HtmlRec)

     D StdOut          PR                  ExtProc('QtmhWrStout')
     D  OutBuffer                 32766A   CONST OPTIONS(*VARSIZE)
     D  OutBufferLen                 10I 0 CONST
     D  apiErrBuff                   16A   OPTIONS(*VARSIZE)

     D ContentType     C                   Const('Content-Type: text/html')
     D LF              C                   Const(X'25')

     D cgiErrorDS      S             16A   Inz(*ALLX'00')
     D szHTML          S            255A   VARYING

     C                   Move      *ON           *INLR

     C                   Eval      szHTML = ContentType + LF 

     C                   Dow       NOT %EOF
     C                   if        szHtml = ''
     C                   Time                    UTime
     C                   eval      szHtml = 'The Time is:' + %Char(UTime)
     C                   eval      szHtml = '

' + szHtml + '

'

     C                   endif
     C                   Eval      szHtml = szHtml + LF 
     C                   callP     StdOut(szHTML :
     C                                   %Len(szHTML) :
     C                                    cgiErrorDS )
     C                   Read      HtmlRec
     C                   eval      szHTML = %TrimR(SRCDTA)
     C                   enddo

     C                   return

Figure 2: This RPG IV CGI program will read/write HTML.

Note that embedding data into the HTML is problematic. I used a simple technique here that compares each source line to the value . If it equals that value, I insert "dynamic HTML." That is HTML that I generate at run time. In this example, I insert the current time.

In the next issue, we will look at configuring the Apache Web server and using CGILIB to more easily merge data with HTML at run time. (Editor's Note: View the follow-on article here.)

Bob Cozzi is a programmer/consultant, writer/author, and software developer of the RPG xTools, a popular add-on subprocedure library for RPG IV. His book The Modern RPG Language has been the most widely used RPG programming book for nearly two decades. He, along with others, speaks at and runs the highly-popular RPG World conference for RPG programmers.

BOB COZZI

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.


MC Press books written by Robert Cozzi available now on the MC Press Bookstore.

RPG TnT RPG TnT
Get this jam-packed resource of quick, easy-to-implement RPG tips!
List Price $65.00

Now On Sale

The Modern RPG IV Language The Modern RPG IV Language
Cozzi on everything RPG! What more could you want?
List Price $99.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: